RESTful-web-service-API-Dokumentation mit Sphinx
Was ist der beste Weg, um markup-Methoden/- URLs für einen RESTful webservice mit ReST/Sphinx? Gibt es eine Standard-domain ist geeignet für die Auszeichnung von URLs durch Ihre möglichen Parameter, HTTP-Methoden, Kopf-und Körper-Inhalt?
Etwas entlang der Linien von:
.. rest:method:: GET /api/foo
:param bar: A valid bar
:extension: json or xml
Retrieve foos for the given parameters. E.g.::
GET /api/foo.json?bar=baz
Macht soetwas schon vorhanden ist oder einer der Standard-Erweiterungen nutzbar, oder muss ich eins selbst zu schreiben?
- Hast du eine Lösung für dieses problem? vor der das gleiche "problem" 🙂
- Siehe Antwort unten.
Du musst angemeldet sein, um einen Kommentar abzugeben.
Den Sphinx Contrib Projekt scheint auch eine HTTP Domain - Paket für die Dokumentation von RESTful HTTP APIs. Sie finden die Dokumentation auf der Python-Pakete Website. Ich kann nicht sprechen, um seine fitness: ich bin gerade erst angefangen zu suchen, in Sphinx, und ich habe ein Bedürfnis, zu dokumentieren, RESTful APIs, und bemerkt dazu beigetragen Paket.
sphinxcontrib-httpdomain
.Da es nicht angezeigt, alle bestehenden Lösung, ich implementiert eine sehr einfache HTTP-domain, die ich nutzen kann um ein Markup-API-Methoden:
Es mir erlaubt, mark-up-Methoden wie diese, und Sie werden gestylt, etwas visuell schön:
Dies war mein Erster Ausflug in die beiden Sphinx Python, so sollte dies als sehr rudimentäre code. Wenn jemand interessiert ist, in die Ausgestaltung dieses aus, bitte Gabel dieses Projekt auf Github!