2

Ich arbeite an einem neuen Django REST Framework Projekt und ich benutze Django REST Swagger, um schöne Dokumentation von Anfang an zu bieten. Allerdings möchte ich diese Dokumentation teilen, ohne eine Staging-Maschine oder ähnliches in Gang setzen zu müssen. Ich möchte nur statische Sphinx-ähnliche Dokumentation erstellen, ohne die ausgefallenen Client-Funktionen. Ich muss die API-Endpunkte nicht wirklich treffen können. Ich möchte nur eine benutzerfreundliche Beschreibung dessen, was Endpunkte existieren, was sie akzeptieren/zurückgeben usw.Kann Django REST Swagger verwendet werden, um statische HTML-Dokumentation zu generieren?

Ist dies mit Django REST Swagger möglich? Wenn nicht, gibt es ein Tool, das das tut? Oder muss ich einfach Sphinx-Dokumentation manuell schreiben?

+0

durch Zufall, hast du etwas finden? – LB40

+0

@ LB40 leider habe ich nichts gefunden. Ich hatte das Gefühl, dass die Community diese anspruchsvollere Art der Dokumentation etwas vorantreiben wollte und es nicht viel Willen war, das zu implementieren, was ich beschrieben habe. Aber das ist nur mein Eindruck. Ich arbeite nicht mehr an diesem Projekt, daher weiß ich nicht genau, wie es um die aktuelle Situation steht. – Ariel

Antwort

-1

Django REST Swagger ermöglicht Ihnen, Dokumentation mit swagger-ui zu generieren. Sie können dem example als Ausgangspunkt folgen. Hier

ist ein Beispiel für Dokumentation Prahlerei-ui mit: http://petstore.swagger.io/