abatilo / sanic-swagger

Easily document your Sanic API with a UI (and attrs!)
MIT License
14 stars 8 forks source link

Need Documentation #20

Open vaulstein opened 5 years ago

vaulstein commented 5 years ago

Require documentation to use

It would be nice to have some initial documentation that would help to get started with the basic swagger document.

Since this is derived from sanic-openapi and sanic-attrs, can we have parts of their documentation that remain the same to at least bootstrap with the basic configurations?

abatilo commented 5 years ago

Some documentation is definitely necessary. But for what it's worth, you can look at the examples folder to see a quick example of what the code should look like!

vaulstein commented 5 years ago

Could you share how do I add path and query params? I couldn't figure this out. I used the below:

@doc.consumes({"user": str}, location="query")