Gibt es Tools zum Definieren der Rest-API im Dokument? [geschlossen]

8

Viele Fragen zum Generieren der Rest-API für HTML-Dokumente.

Aber Eier kommen von Hühnern.

In vielen Fällen muss die Architektur die API definieren. Es ist eine Verbindung zwischen Web-Entwicklern und iOS / Android-Client-Entwicklern.

So gibt es so ein Werkzeug oder Web, wir können Dinge tun:

Neue API schreibe die subURL schreibe die POST / GET-Methode schreibe die post-Parameter schreibe die zurückgegebenen Antworten Schreiben Sie die Beispielanforderung, alle möglichen Bedingungen, Fehlercodes. Nach all dem gibt es ein Dokument oder einen Online Doc HTML.

Wir können es bearbeiten, aktualisieren es nach Zeiten vorbei. Der Web- / Client-Entwickler muss sich nur das Dokument ansehen, dann können sie loslegen.

Gibt es irgendein Werkzeug, das das archivieren kann? Danke.

    
Jacob 06.09.2013, 08:13
quelle

1 Antwort

6

Es gibt einige Spezifikationen für Dokumente, die es Clients ermöglichen, RESTful-APIs zu finden.

Ich habe Swagger benutzt und es funktioniert gut. Die Spezifikation behandelt die Dinge, die Sie erwähnt haben:

  • JSON Schema zur Beschreibung der Anfrage / Antworten
  • Eine Liste der Fehlercodes / Bedingungen
  • Eine Codegen-Bibliothek , um clientseitigen Code für eine Reihe von Sprachen wie Javascript, Java, Scala, Objectove- C, PHP, Python, Ruby und mehr.
theon 06.09.2013 12:04
quelle

Tags und Links