SwagDoc

Swagdoc

Swagdoc é uma biblioteca Delphi para gerar arquivo swagger.json para swagger spec versão 2.0. Crie uma API REST Public Documentation usando Swagger 2.0 para o idioma Delphi. A única responsabilidade do Swagdoc é gerar o arquivo Swagger.json. O arquivo swagger.json é responsável por conter toda a documentação da sua API REST. Este arquivo deve ser anexado aos arquivos Swagger UI (interface do usuário).

Swagger (API aberta) - Versão 2.0

O Swagdoc segue a especificação 2.0 porque é mais popular no mercado e também porque é considerada uma versão mais estável para existir mais longa. O Swagdoc ainda não suporta a versão Swagger 3.0, mas dependendo da demanda e das contribuições para o projeto que ele pode evoluir para suportar o SPEC 3.0.

O principal pré -requisito para trabalhar com Swagdoc é conhecer a especificação Swagger 2.0 que pode ser vista no link abaixo.

https://github.com/oai/openapi-specification/blob/master/versions/2.0.md

https://swagger.io/docs/specification/2-0/basic-structure/

Ao criar uma documentação de arrogância para sua API REST, você pode produzir uma página como o exemplo a seguir.

https://app.swaggerhub.com/apis-docs/swagdoc/sample-api/v1

JSON Schema

https://github.com/oai/openapi-specification/blob/master/versions/2.0.md#schemaobject

http://json-schema.org

Discursos de swagdoc

https://www.youtube.com/watch?v=9u3hp3b5ut0 (pt-br)

https://www.youtube.com/watch?v=phgmqad8o6c (pt-br)

Referências e tutoriais de arrogância

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

Ferramentas de arrogância

• Swagger: https://swagger.io

• Editor de swagger: https://editor.swagger.io

• Swagger Hub: https://swagger.io/tools/swaggerhub

• A amostra clássica de arrogância: http://petstore.swagger.io

• Ferramentas e integrações: https://swagger.io/tools/open-source/open-source-integrações

Arquivos de distribuição da interface do usuário da Swagger

Para você produzir uma página contendo uma documentação de arrogância, você precisa dos arquivos de distribuição da interface do usuário do Swagger.

Esses arquivos que você pode encontrar no repositório Github Swagger-Api / Swagger-UI.

https://github.com/swagger-api/swagger-ui/tree/master/dist

Primeiro, você precisa baixar os arquivos de interface do usuário do Swagger e gerar o arquivo swagger.json. Você precisa alterar o arquivo index.html para indicar o caminho relativo do local em que o arquivo swagger.json está localizado no seu servidor da web que está hospedando os arquivos de interface do usuário do Swagger.

Veja um exemplo abaixo.