Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better Swagger spec generation #26

Open
igortg opened this issue Sep 4, 2018 · 2 comments
Open

Better Swagger spec generation #26

igortg opened this issue Sep 4, 2018 · 2 comments

Comments

@igortg
Copy link
Contributor

igortg commented Sep 4, 2018

Currently, Swagger spec is generated using Flasgger. But to use Flasgger, each REST resource must have its unique class, leading to the hackish code at resourcefactory.py.

Find a better way to generate Swagger specs (maybe made an script available to compile the spec based on the models registered on the API).

@wgwz
Copy link

wgwz commented Dec 29, 2020

Are there any better methods for creating swagger documentation nowadays? Any examples available?

@igortg
Copy link
Contributor Author

igortg commented Feb 6, 2021

One way would be to generate the docs base on the serializer class that is being used within the endpoint or resource (instead of the resource itself). I think FastAPI does something like that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants