Tag: api-doc

Inline-Dokumentation für RESTful-web-APIs.
apidoc unterbreitet erstellt eine Dokumentation von API Annotationen im Quellcode.

Wie dokumentieren Python-Funktion Parameter mit sphinx-apidoc unterbreitet

Anzahl der Antworten 2 Antworten
Ich versuche es zu bereinigen, meine python-code-Dokumentation, und beschlossen,sphinx-docweil es gut aussieht. Ich mag, wie ich den Verweis auf andere Klassen und Methoden mit tags wie: :class:`mymodule.MyClass` About my class. :meth:`mymodule.MyClass.myfunction` And my cool function Ich versuche,

Generieren WebAPI Dokumentation in Fors json-format

Anzahl der Antworten 3 Antworten
Habe ich eine WebAPI mit .Net 4.5 und dokumentieren wollen, die diese API verwenden Swagger. Ich habe swagger-ui in meine .Net-Projekt. Wenn ich jetzt navigieren Sie zu ../swagger-ui/index.html erfolgreich öffnet pet-store-api-docs (json) in swagger-UI-format. Meine Frage ist

Wie nutze ich die Modelle stolzieren Abschnitt?

Anzahl der Antworten 1 Antworten
Innerhalb der Swagger-API-Dokumentation gibt es innerhalb der json-neben dem apis-array ein Modell-Objekt-Eintrag, aber keine Dokumentation darüber. Wie kann ich diese "Modelle" Teil? { apiVersion: "0.2", swaggerVersion: "1.1", basePath: "http://petstore.swagger.wordnik.com/api", resourcePath: "/pet.{format}" ... apis: [...] models: {...} }

Slate vs Swagger - Was ist besser und welche haben mehr Optionen?

Anzahl der Antworten 4 Antworten
Muss ich mein Dokument API. Ich habe mit einer von Ihnen Schiefer Oder Swagger. Ich möchte wissen, was man haben mehr Optionen, vor-und Nachteile, welche besser ist. InformationsquelleAutor der Frage Sariban D'Cl | 2015-04-06