Я новичок в Swagger. У меня есть API, и я хочу документировать его с помощью Swagger на основе модели, а не на аннотации. Пожалуйста, предоставьте некоторое руководство, как я могу это сделать? Заранее спасибо! Мне нужна литература, примеры, учебники и т. Д.Документирующий API с Swagger
1
A
ответ
1
Swagger - это самый простой способ создать документацию API REST и поле для песка для вашего API. Вам нужно просто следовать некоторому правилу аннотации, определяемому API-интерфейсом swagger.
Вы должны узнать следующую вещь первого
- Основные концепции REST API
- REST API с Play.
- Посмотрите аннотации Swagger.
Вы можете увидеть демо на http://petstore.swagger.io/
Чтобы понять поток видеть в следующих файлах
https://github.com/swagger-api/swagger-play-sample-app/blob/master/conf/routes
+0
другой способ без аннотации ад https://github.com/iheartradio/play-swagger –
Смежные вопросы
- 1. Документирующий API, который может быть изменен
- 2. Подтверждение декларации API Swagger с использованием официальной схемы API Swagger
- 3. документирующий набор данных с roxygen2
- 4. RESTful API Testbed с Swagger
- 5. Самостоятельный документирующий интерфейс REST
- 6. Swagger api листинг пуст
- 7. Документирующий атрибут класса
- 8. Документация по API Swagger
- 9. APEX Rest API - Swagger
- 10. swagger или api first
- 11. Редактирование Swagger api-docs?
- 12. , документирующий список фреймов данных с roxygen2
- 13. Swagger api-docs to swagger.json?
- 14. Настройка версии Api с Swagger UI
- 15. Как использовать swagger с API OAuth?
- 16. Mocking Rest Api с документацией Swagger
- 17. Настройка Swagger api с Play 2.4
- 18. Документация по веб-API с использованием swagger
- 19. Как проверить API в тестах с Swagger?
- 20. Документирование/Проектирование веб-API ASP.NET с Swagger
- 21. API фальшивки Swagger с узлом размаха
- 22. Документация API Swagger REST с загрузкой Spring
- 23. C# web api swagger integration
- 24. Написание api-doc для Swagger
- 25. C#, web api, swashbuckler/swagger
- 26. Самостоятельный документирующий машинописный/javascript-код
- 27. Документирующий препроцессор определяет в Doxygen
- 28. swagger - пустой список без API
- 29. API Gateway и Swagger UI
- 30. swagger listing api for worknik
Ваши вопросы действительно не хватает деталей. Я понимаю, что вы добавили теги, которые могут иметь отношение к вопросу, но вам нужно предоставить версии используемых вами инструментов и так далее. Я думаю, что этот вопрос слишком расплывчато для SO и лучше будет рассмотрен в группе Google Swagger. – Ron
Ну все три технологии с последними версиями. Я должен реализовать API с помощью scala, swagger и play framework с последними версиями. Я совершенно новый в этих трех. Я не знаю, как мне его начать. Было бы полезно, если бы вы могли вести меня. Благодаря! – Falconx
Я не знаю, какая последняя версия игры. Лучше быть явным. Прямо сейчас вы можете интегрировать swagger core 1.3 с игрой. Нет надлежащей документации, но проверьте образец https://github.com/swagger-api/swagger-core/tree/v1.3.12/samples/scala-play2 – Ron