search

swagger-api / swagger-play

Apache License 2.0
330 stars 181 forks source link

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

Open alialerwi opened 6 years ago

asdcdow commented 6 years ago

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.

mikeumus commented 6 years ago

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.

poroszd commented 6 years ago

@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).