Я пытаюсь использовать пользовательский интерфейс Swagger, и он говорит, что я должен начать с написания api-doc, который описывает точное api для REST api. Проблема в том, что я понятия не имею, что это значит. Этот документ написан на простом английском языке? Или есть определенный формат, который сможет сгенерировать пользовательский интерфейс?Написание api-doc для Swagger
Спасибо!
Swagger - это спецификация для описания API REST. Документацию по спецификации можно найти здесь - https://github.com/swagger-api/swagger-spec.
Как правило, существует два способа документировать ваш API. Если у вас уже есть API с кодом, вы можете использовать любую из существующих библиотек (https://github.com/swagger-api/swagger-spec#additional-libraries) для интеграции в ваш код и создания документации во время выполнения. Некоторые из этих библиотек также предлагают автономное создание таких документов.
Если вы хотите разработать API или не хотите интегрировать другую библиотеку в свое приложение, вы можете использовать https://github.com/swagger-api/swagger-editor либо локально, либо с онлайн-версией - http://editor.swagger.io.
После того, как у вас есть документация, вы можете использовать интерфейс Swagger для визуализации и тестирования.