Czy są narzędzia do definiowania interfejsu API odpoczynku w dokumencie?

Question

Wiele pytań dotyczących generowania interfejsu API odpoczynku do dokumentów html.

Ale jajka pochodzą od kurczaka.

W wielu przypadkach architektura musi definiować interfejs API. Jest to połączenie między programistami stron internetowych a deweloperami aplikacji dla systemu iOS/Android.

Więc jest tam taki rodzaj narzędzia lub sieci, co możemy zrobić, wykonaj następujące czynności:

Nowe API napisać subURL napisać metodę POST/GET napisać parametry pocztowe napisać Zwracany ODPOWIEDZI zapisu przykładowe żądanie, wszelkie rodzaje warunków, kody błędów. Po tym wszystkim znajduje się dokument lub HTML-a.

Możemy edytować, aktualizować po upłynięciu czasu. Programista sieci/klienta, po prostu trzeba obejrzeć dokument, a następnie są gotowi do pracy.

Czy istnieje narzędzie do archiwizacji tego typu? Dziękuję Ci.

Answer 1

Istnieje kilka specyfikacji dokumentów, które pozwalają klientom wykryć interfejsy API RESTful.

• Swagger (demo)
• apiary
• JSON Home
• używać Google własne Discovery Service, jednak w przeciwieństwie do innych, niestety nie sądzę, istnieje open source bibliotek, które pomogą Ci wykorzystać wystawiać go od własne API.

Użyłem chwalca i działa dobrze. Spec obsługuje rzeczy, które zostały wymienione:

• JSON Schema, aby opisać żądania/odpowiedzi
• lista kodów błędów/warunki
• codegen library wygenerować klienta kod boczny dla wielu języków, takich jak JavaScript , Java, Scala, Objectove-C, PHP, Python, Ruby i więcej.