SwagDoc
1.0.0
Swagdoc est une bibliothèque Delphi pour générer un fichier Swagger.json pour Swagger Spec version 2.0. Créez une API de documentation publique à l'aide de Swagger 2.0 pour la langue Delphi. La seule responsabilité de Swagdoc est de générer le fichier swagger.json. Le fichier sbagger.json est chargé de contenir toute la documentation de votre API REST. Ce fichier doit être joint aux fichiers d'interface utilisateur Swagger (interface utilisateur).
Swagdoc suit la spécification 2.0 car il est plus populaire sur le marché et aussi parce qu'il est considéré comme une version plus stable pour exister le plus longtemps. Swagdoc ne prend pas encore en charge la version Swagger 3.0, mais en fonction de la demande et des contributions au projet, elle peut évoluer pour prendre en charge Spec 3.0.
La principale condition préalable pour travailler avec Swagdoc est de connaître la spécification Swagger 2.0 qui peut être consultée dans le lien ci-dessous.
https://github.com/oai/openapi-specification/blob/master/versions/2.0.md
https://swagger.io/docs/specification/2-0/basic-structure/
Lors de la création d'une documentation Swagger pour votre API REST, vous pouvez produire une page comme l'exemple suivant.
https://app.swaggerhub.com/apis-docs/swagdoc/sample-api/v1
https://github.com/oai/openapi-specification/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/Documentation-an-existing-api-with-swagger-2.pdf
https://idratherbewriting.com/learnapidoc/pubapis_swagger_intro.html
Swagger: https://swagger.io
Éditeur de fanfaronnade: https://editor.swagger.io
Swagger Hub: https://swagger.io/tools/swaggerhub
L'échantillon de fanfaronnage classique: http://petstore.swagger.io
Outils et intégrations: https://swagger.io/tools/open-source/open-source-integrations
Pour que vous puissiez produire une page contenant une documentation Swagger, vous avez besoin des fichiers de distribution d'interface utilisateur Swagger.
Ces fichiers que vous pouvez trouver dans le référentiel GitHub Swagger-API / Swagger-UI.
https://github.com/swagger-api/swagger-ui/tree/master/dist
Vous devez d'abord télécharger les fichiers d'interface utilisateur Swagger et générer le fichier swagger.json. Vous devez ensuite modifier le fichier index.html pour indiquer le chemin relatif de l'emplacement où le fichier swagger.json est situé sur votre serveur Web qui héberge les fichiers d'interface utilisateur Swagger.
Voir un exemple ci-dessous.
