SwagDoc

Свагдок

Swagdoc - это библиотека Delphi для генерации файла swagger.json для Swagger Spec версии 2.0. Создайте API общедоступной документации REST, используя Swagger 2.0 для языка Delphi. Единственная ответственность Swagdoc - генерировать файл Swagger.json. Файл Swagger.json отвечает за содержание всей документации для вашего API REST. Этот файл должен быть прикреплен к файлам пользовательского интерфейса Swagger (пользовательский интерфейс).

Swagger (Open API) - Версия 2.0

Swagdoc следует спецификации 2.0, потому что он более популярен на рынке, а также потому, что он считается более стабильной версией для существования самой длинной. Swagdoc еще не поддерживает версию Swagger 3.0, но в зависимости от спроса и взносов в проект, который он может развиваться для поддержки Spec 3.0.

Основной предпосылкой для работы с Swagdoc является узнать спецификацию Swagger 2.0, которая может быть просмотрена по ссылке ниже.

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

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

При создании документации Swagger для вашего API REST вы можете создать страницу, подобную следующему примеру.

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

Схема JSON

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

http://json-schema.org

Swagdoc Речи

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-fecisting-api-with-swagger-2.pdf

https://idratherbewriting.com/learnapidoc/pubapis_swagger_intro.html

Swagger Tools

• Swagger: https://swagger.io

• Редактор Swagger: https://editor.swagger.io

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

• Классический пример Swagger: http://petstore.swagger.io

• Инструменты и интеграции: https://swagger.io/tools/open-source/open-source-integrations

Swagger UI -файлы распределения

Чтобы вы могли создать страницу, содержащую документацию Swagger, вам нужны файлы распределения пользовательского интерфейса Swagger.

Эти файлы вы можете найти в репозитории GitHub Swagger-API / Swagger-UI.

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

Сначала вам нужно загрузить файлы пользовательского интерфейса Swagger и генерировать файл swagger.json. Затем вам нужно изменить файл index.html, чтобы указать относительный путь местоположения, где файл Swagger.json находится на вашем веб -сервере, который размещает файлы пользовательского интерфейса Swagger.

См. Пример ниже.