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.
InformationsquelleAutor deceze | 2010-12-28
Schreibe einen Kommentar