akvo-rsr icon indicating copy to clipboard operation
akvo-rsr copied to clipboard

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

Open MichaelAkvo opened this issue 1 year ago • 0 comments

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

MichaelAkvo avatar Mar 30 '23 14:03 MichaelAkvo