search

noirbizarre / flask-restplus

Fully featured framework for fast, easy and documented API development with Flask
http://flask-restplus.readthedocs.org
Other
2.73k stars 507 forks source link

get REST specification via GET request #270

Closed andreassteffen closed 7 years ago

andreassteffen commented 7 years ago

HI, i need to get the information what parameters and the types thereof a given get method accepts. Can I get that information via a get request? Does flask-restplus provide functionality? Many thanks, A

postrational commented 7 years ago

If you go to your Flask-RESTPlus generated API's Swagger UI docs, you can type in swagger.json at the end of the URL to get the OpenAPI specification of your API.

For example, if your swagger UI is at http://localhost:8888/api/, go to http://localhost:8888/api/swagger.json

andreassteffen commented 7 years ago

thanks and great. that worx!!!