REST-API-Dokumentgenerierung

Question

Gibt es eine Bibliothek, die ein Markup zum Schreiben der REST-API-Dokumentation bietet? Ich habe mehrere Unternehmen, die ähnliche verwenden Dokumentation Muster gesehen, z:

http://api.teamlab.com/2.0/

http://www.fullcontact.com/docs/?category=person

Ich frage mich, ob sie die gleiche Bibliothek oder Service verwenden. Im Wesentlichen sollte die Bibliothek Seiten für API-Navigation, Suche und Anzeige (ähnlich wie YARD für Ruby-Dokumentation) basierend auf dem Markup-Text generieren.

Dies ist, was ich bisher gefunden habe:

• rapi_doc gem. Hier ist eine article diskutieren die Verwendung.

Answer 1

Sie sollten sich unbedingt Swagger ansehen.

Es ist Open Source, das von Hunderten von APIs verwendet wird und auch von 3scale in seiner API Management-Lösung unter dem Namen Active Docs verwendet wird.

Answer 2

Auschecken IO/Docs von Mashery.

Mit Mashery I/O Docs, der nächsten Generation der API-Dokumentation und -Exploration, können Entwickler Live-API-Aufrufe direkt aus Ihren Dokumenten ausführen. Think Docs treffen auf Tests und Debugging, alles in einer praktischen, interaktiven Oberfläche.

Schauen Sie sich die Parse API Docs für ein weiteres Beispiel für großartige Dokumente.

Auch haben wir viel Zeit damit verbracht, die FullContact API Docs zu entwerfen. Wir verwenden auch die Apigee Live API Console.

Answer 3

Dies ist ein nützliches Juwel für api documentaion (Rails4 und Rails5)

ApiDoco https://rubygems.org/gems/apidoco/versions/1.2.0.

Es ist sehr einfach einzurichten und hat eine gute Benutzererfahrung.