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

Best practices for generating API documentation? #1

Open
neilfrndes opened this issue Jul 11, 2021 · 0 comments
Open

Best practices for generating API documentation? #1

neilfrndes opened this issue Jul 11, 2021 · 0 comments

Comments

@neilfrndes
Copy link

Would you be able to add a small example to illustrate best practices for creating API documentation for the end user? I currently use drf-yasg to automatically generate an openapi schema and API browser. It works well for standard CRUD endpoints, but gets messy when non standard and nested models are involved.

ps: Thank you for the excellent best practices for startups guide!

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

1 participant