Аннотации Swagger и спецификация Swagger 2.0

Я разработал REST API с аннотациями Swagger. Мне удалось показать документацию api в приложении swagger-ui, очень приятно.

Проблема: я пытаюсь создать клиентов в соответствии с этой спецификацией, используя URL-адрес, предоставленный swagger в соответствии с моими аннотациями. Проблема в том, что он кажется несовместимым, или, по крайней мере, я не понимаю, как сделать редактор swagger читает мой URL и с этого момента генерирует клиентов. Но редактор swagger сообщает мне о каких-то ошибках ...

Можно ли интегрировать мой аннотированный API чванства с редактором чванства?

Спасибо.


person Jordi    schedule 16.06.2015    source источник


Ответы (3)


Вопрос кажется немного запутанным.

Если вы пытаетесь сгенерировать клиентов из своей спецификации REST API Swagger, вам следует взглянуть на проект Swagger-Codegen.

Описание проекта:

swagger-codegen содержит движок на основе шаблонов для генерации клиентского кода на разных языках путем синтаксического анализа объявления ресурсов Swagger.

person ipeluffo    schedule 02.07.2015

Не уверен, правильно ли я понял вопрос. Если вы хотите создавать клиентов API онлайн, вы используете http://generator.swagger.io (помимо http://editor.swagger.io). Вот пример создания клиента API для Java:

curl -X POST -H "content-type:application/json" -d '{"swaggerUrl":"http://petstore.swagger.io/v2/swagger.json"}' http://generator.swagger.io/api/gen/clients/java
person William Cheng    schedule 12.07.2015

Редактор Swagger используется только для редактирования спецификации swagger в формате json или yml. Он никоим образом не имеет отношения к аннотациям чванства. Однако некоторые из скелетов сервера, которые создаются на веб-сайте swagger-editor, содержат аннотации. Аннотации - это способ обратного проектирования вашего API для создания файла json, чтобы пользовательский интерфейс swagger мог отображать веб-страницу на основе общедоступного URL-адреса вашего файла swagger.json. Если вы все равно поддерживаете json-файл со спецификацией swagger, аннотации на самом деле не нужны, вы также можете просто обслуживать необработанный файл swagger.json, а не json, который создается аннотациями.

Что касается вашего вопроса: «Можно ли интегрировать ваш API с редактором Swagger?»… Все возможно, но я не уверен, как и почему вы хотите их интегрировать.

person cosbor11    schedule 23.10.2015
comment
Какой инструмент вы бы использовали для обратного проектирования API и создания swagger.json на основе аннотаций? - person wimnat; 14.07.2016