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

Feature Request: Generate API reference documentation with django-rest-framework #5274

Open
MichaelAkvo opened this issue Mar 30, 2023 · 0 comments

Comments

@MichaelAkvo
Copy link
Contributor

What are you trying to do?

Look up the API documentation for RSR. Unfortunately, it's severely out of date and not really complete in the wiki.

Describe the solution you'd like

Generate documentation with DRF and swagger. It should be possible to either generate an OpenAPI JSON or HTML straight away that can be used by sphinx.

Have you consider alternatives?

Add a swagger endpoint: https://www.django-rest-framework.org/topics/documenting-your-api/#generating-documentation-from-openapi-schemas

But I'm not sure if there's a way to provide meta information in the documentation of the endpoints of how to group them.

Additional context

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant