SwagDoc
1.0.0
SwagDoc es una biblioteca de Delphi para generar el archivo Swagger.json para Swagger Spec Versión 2.0. Cree una API REST de documentación pública usando Swagger 2.0 para el lenguaje Delphi. La única responsabilidad de SwagDoc es generar el archivo swagger.json. El archivo Swagger.json es responsable de contener toda la documentación para su API REST. Este archivo debe adjuntarse a los archivos de UI Swagger (interfaz de usuario).
SwagDoc sigue la especificación 2.0 porque es más popular en el mercado y también porque se considera una versión más estable para existir más larga. SwagDoc aún no admite la versión Swagger 3.0, pero dependiendo de la demanda y las contribuciones al proyecto que puede evolucionar para admitir la especificación 3.0.
El principal requisito previo para trabajar con SwagDoc es conocer la especificación Swagger 2.0 que se puede ver en el siguiente enlace.
https://github.com/oai/openapi-specification/blob/master/versions/2.0.md
https://swagger.io/docs/specification/2-0/basic-structure/
Al crear una documentación de Swagger para su API REST, puede producir una página como el siguiente ejemplo.
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/documenting-an-existing-api-with-swagger-2.pdf
https://idratherbewriting.com/learnapidoc/pubapis_swagger_intro.html
Swagger: https://swagger.io
Editor de Swagger: https://editor.swagger.io
Swagger Hub: https://swagger.io/tools/swaggerhub
La muestra clásica de Swagger: http://petstore.swagger.io
Herramientas e integraciones: https://swagger.io/tools/open-source/open-source-integrations
Para que usted produzca una página que contenga una documentación de Swagger, necesita los archivos de distribución de interfaz de usuario de Swagger.
Estos archivos que puede encontrar en el repositorio Github Swagger-API / Swagger-UI.
https://github.com/swagger-api/swagger-ui/tree/master/dist
Primero debe descargar los archivos de interfaz de usuario de Swagger y generar el archivo swagger.json. Luego debe cambiar el archivo index.html para indicar la ruta relativa de la ubicación donde el archivo swagger.json se encuentra en su servidor web que está alojando los archivos de interfaz de usuario de Swagger.
Vea un ejemplo a continuación.
