swagger-play icon indicating copy to clipboard operation
swagger-play copied to clipboard

Is there clear explanation of how to use swagger-play please ?

Open alialerwi opened this issue 8 years ago • 3 comments

alialerwi avatar Aug 23 '17 08:08 alialerwi

There is documentation for how to set up the plugin in the version specific folders of the project (e.g. https://github.com/swagger-api/swagger-play/tree/master/play-2.6/swagger-play2). This project just adds a HTTP call that returns a description of all of your REST API encoded in JSON. If you want a UI, for this description, you will have to set that up separately. Here is a walkthrough of the entire set up.

asdcdow avatar Sep 10 '17 20:09 asdcdow

I've followed the steps and found the correct version that supports play 2.5 (#161) but when I sbt compile or sbt run, nothing is written to /swagger.json except the default structure. Something is missing in the ReadMe.

mikeumus avatar Nov 30 '17 19:11 mikeumus

@mikeumus I think you need the @io.swagger.annotations.Api annotation on the controller class (at least in my case this was the problem with the same symptoms).

poroszd avatar Dec 16 '17 22:12 poroszd