SwagDoc
1.0.0
Swagdoc ist eine Delphi -Bibliothek, in der Swagger.json -Datei für die Swagger Spec Version 2.0 generiert wird. Erstellen Sie eine öffentliche Dokumentations -REST -API mit Swagger 2.0 für die Delphi -Sprache. Die einzige Verantwortung von Swagdoc besteht darin, die Datei Swagger.json zu generieren. Die Datei Swagger.json ist dafür verantwortlich, die gesamte Dokumentation für Ihre REST -API zu enthalten. Diese Datei muss an die Swagger UI (User Interface) -Dateien angehängt werden.
Swagdoc folgt der Spezifikation 2.0, da sie auf dem Markt beliebter ist und auch, weil es als stabilere Version als am längsten angesehen wird. Swagdoc unterstützt die Swagger 3.0 -Version noch nicht, aber abhängig von der Nachfrage und den Beiträgen zum Projekt kann es sich entwickeln, um Spec 3.0 zu unterstützen.
Die Hauptvoraussetzung für die Arbeit mit Swagdoc besteht darin, die Swagger 2.0 -Spezifikation zu kennen, die im folgenden Link angezeigt werden kann.
https://github.com/oai/openapispecification/blob/master/versions/2.0.md
https://swagger.io/docs/specification/2-0/basic-structure/
Beim Erstellen einer Prahlerin -Dokumentation für Ihre REST -API können Sie eine Seite wie das folgende Beispiel erstellen.
https://app.swaggerhub.com/apis-docs/swagdoc/sample-api/v1
https://github.com/oai/openapispecification/blob/master/versions/2.0.md#schemaObject
http://json-schema.org
https://www.youtube.com/watch?v=9U3HP3B5UT0 (PT-br)
https://www.youtube.com/watch?v=phgmqad8o6c (pt-br)
https://swagger.io/swagger/media/blog/wp-content/uploads/2017/02/documenting-an-existing-api-with-swagger-2.pdf
https://idhratherbewriting.com/learnapidoc/pubapis_swagger_intro.html
Swagger: https://swagger.io
Swagger Editor: https://editor.swagger.io
Swagger Hub: https://swagger.io/tools/swaggerhub
Die klassische Swagger -Probe: http://petstore.swagger.io
Tools und Integrationen: https://swagger.io/tools/open-source/open-source-integrations
Damit Sie eine Seite mit einer Sprist -Dokumentation erstellen können, benötigen Sie die Distributionsdateien der Swagger UI.
Diese Dateien finden Sie im GitHub Swagger-API / Swagger-UI-Repository.
https://github.com/swagger-api/swagger-ui/tree/master/dist
Zuerst müssen Sie die Swagger User Interface -Dateien herunterladen und die Datei Swagger.json generieren. Anschließend müssen Sie die Datei index.html ändern, um den relativen Pfad des Ortes anzugeben, an dem sich die Datei Swagger.json auf Ihrem Webserver befindet, auf dem die Swagger -Benutzeroberflächen -Dateien gehostet werden.
Siehe ein Beispiel unten.
