2015-04-20 5 views
1

Я новичок в Swagger. У меня есть API, и я хочу документировать его с помощью Swagger на основе модели, а не на аннотации. Пожалуйста, предоставьте некоторое руководство, как я могу это сделать? Заранее спасибо! Мне нужна литература, примеры, учебники и т. Д.Документирующий API с Swagger

+0

Ваши вопросы действительно не хватает деталей. Я понимаю, что вы добавили теги, которые могут иметь отношение к вопросу, но вам нужно предоставить версии используемых вами инструментов и так далее. Я думаю, что этот вопрос слишком расплывчато для SO и лучше будет рассмотрен в группе Google Swagger. – Ron

+0

Ну все три технологии с последними версиями. Я должен реализовать API с помощью scala, swagger и play framework с последними версиями. Я совершенно новый в этих трех. Я не знаю, как мне его начать. Было бы полезно, если бы вы могли вести меня. Благодаря! – Falconx

+0

Я не знаю, какая последняя версия игры. Лучше быть явным. Прямо сейчас вы можете интегрировать swagger core 1.3 с игрой. Нет надлежащей документации, но проверьте образец https://github.com/swagger-api/swagger-core/tree/v1.3.12/samples/scala-play2 – Ron

ответ

1

Swagger - это самый простой способ создать документацию API REST и поле для песка для вашего API. Вам нужно просто следовать некоторому правилу аннотации, определяемому API-интерфейсом swagger.

Вы должны узнать следующую вещь первого

  1. Основные концепции REST API
  2. REST API с Play.
  3. Посмотрите аннотации Swagger.

Вы можете увидеть демо на http://petstore.swagger.io/

Чтобы понять поток видеть в следующих файлах

https://github.com/swagger-api/swagger-play-sample-app/blob/master/app/controllers/PetController.scala

https://github.com/swagger-api/swagger-play-sample-app/blob/master/conf/routes

+0

другой способ без аннотации ад https://github.com/iheartradio/play-swagger –

Смежные вопросы