Gibt es Tools zum Definieren der Rest API im Dokument?

Question

Viele Fragen über Generate Rest API zu HTML-Dokumenten gefragt.

Aber Eier kommen vom Huhn.

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 eine solche Art von Werkzeug oder Web, können wir Dinge folgen Sie:

Neue eine API die subURL schreiben schreiben die POST/GET-Methode die Post Parameter schreiben die zurückgegebenen Antworten Schreib schreiben die Beispielanforderung, alle möglichen Bedingungen, Fehlercodes. Nach all dem gibt es einen Doc oder Online Doc HTML dort.

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

Gibt es irgendeine Art von Werkzeug kann dies archivieren? Vielen Dank.

Answer 1

Es gibt einige Spezifikationen für Dokumente, mit denen Clients RESTful-APIs erkennen können.

• Swagger (demo)
• apiary
• JSON Home
• Google nutzen, um ihre eigenen Discovery Service, aber im Gegensatz zu den anderen, leider glaube ich nicht, dass es Open Source-Bibliotheken, die Ihnen helfen aussetzen verwenden Sie es aus Ihre eigenen APIs.

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

• JSON Schema Anfrage/Antworten
• Eine Liste der Fehlercodes/Bedingungen
• A beschreiben codegen library Client-Seite Code für eine Reihe von Sprachen wie Javascript zu erzeugen Java, Scala, Objectove-C, PHP, Python, Ruby und mehr.