search

alysivji / falcon-apispec

apispec plugin that generates OpenAPI specification (aka Swagger Docs) for Falcon web applications.
MIT License
44 stars 31 forks source link

Can this be used with py2swagger? #6

Closed mumrau closed 6 years ago

mumrau commented 6 years ago

Hello,

I'm very unaware and my question might actually be quite stupid, but is this usable with py2swagger or do I need to implement the creation of the apispec in my python code?

Thanks in advance !

alysivji commented 6 years ago

This is a separate application than py2swagger. You will need to implement the creation of apispec in your code with this plugin enabled.

There is example code in the Quickstart. A more detailed example can be found in my falcon batteries included repo (routes.py and apispec.py)

mumrau commented 6 years ago

Oh thanks for your repo, this will help faster than reading the whole docs given the fact I just need basic apidoc.

Thanks !

alysivji commented 6 years ago

Lemme know if you need a hand. Happy to help out; need to sit down and make these instructions a bit clearer.

mumrau commented 6 years ago

Yeah that might be useful to specify that this repo doesn't have anything to deal with py2swagger -yet-, neither with the py2swagger falcon plug-in (which didn't fit my usecase).