Welcome to aiohttp-swagger documentation!¶
aiohttp-swagger: Swagger API Documentation builder for aiohttp server
Code | https://github.com/cr0hn/aiohttp-swagger |
Issues | https://github.com/cr0hn/aiohttp-swagger/issues/ |
Python version | Python 3.4 and above |
License | BSD |
Author | Daniel Garcia (cr0hn) - @ggdaniel |
Index¶
- Installation
- Quick start
- Customizing Doc description and more
- Frequently Asked Questions
- Where start the Swagger documentation in my function doc?
- Can I Combine the Swagger documentation with my usually Sphinx doc?
- How can I group a list of End-Point?
- How can I change the Title of a group of End-Points?
- What happens if I use YAML file and function documentation for build Swagger doc at the same time?
Examples¶
If you need more examples, there are some in this folder: aiohttp_swagger/examples.
Contributing¶
You want to collaborate on this project? Nice! Your contribution is very welcome :)
You can send me a GitHub Pull Request with your proposal.