Gibt es eine Möglichkeit, http-Fehlercodes mit spring-restdocs zu dokumentieren? Ich habe nichts über das gleiche auf http://docs.spring.io/spring-restdocs/docs/current/reference/html5/Wie dokumentiert man HTTP-Fehlercodes mit spring-restdocs
finden Sie jede Hilfe mit einem Beispiel wird sehr geschätzt.
Grüße, Surya
Frühling REST Text & Tabellen helfen Ihnen Codes dokumentieren HTTP-Fehler nicht alles bieten zu. Die Theorie ist, dass es nicht unbedingt notwendig ist, Fehlercodes zu dokumentieren, und sicherlich nicht für jede einzelne Ressource in der API.
Die HTTP-Spezifikation enthält Definitionen für ihre Fehlercodes, und Ihre API sollte den Definitionen entsprechen. Dies ermöglicht Benutzern der API, ihr vorhandenes Wissen über HTTP zu verwenden, anstatt etwas Neues zu lernen, das spezifisch für Ihre API ist. Wenn Sie nicht sicher sind, ob Ihre Benutzer dieses Wissen bereits besitzen, können Sie einige Informationen über HTTP-Fehlercodes in einen Übersichtsteil der Dokumentation aufnehmen. Dies ist der Ansatz in einem der Beispielprojekte von Spring REST Docs. Sowohl die Asciidoctor source als auch die resultierende HTML documentation sind online verfügbar.
Ich war auch neugierig zu wissen, wie Sie die generierte HTML-Datei nehmen und an die Verbraucher veröffentlichen? Haben Sie eine Web-App, die all diese Dateien hostet? – sunshine
@schinta Das ist wirklich eine eigene Frage. Die Dokumentation bietet jedoch einige Informationen zum Bereitstellen der Dokumentation als statischen Inhalt mithilfe von Spring Boot. Siehe http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#getting-started-build-configuration-grade-packaging-the-documentation, zum Beispiel –