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

feat: OpenAPI documentation #9

Open
VikashKothary opened this issue Dec 5, 2020 · 1 comment
Open

feat: OpenAPI documentation #9

VikashKothary opened this issue Dec 5, 2020 · 1 comment

Comments

@VikashKothary
Copy link
Member

  • WHY: This will read the Django project and display interactive documentation on how to use the API minimising the barrier to entry for developing on top of the API. It will also allow for an API first approach to the API.

  • HOW: This was just the first one that came up when I googled it: https://django-rest-swagger.readthedocs.io/en/latest/. But there's a bunch of packages that might help with this.

  • WHAT: This is an example, see: https://petstore.swagger.io/.

@VikashKothary VikashKothary changed the title Add Django REST OpenAPI Documentation Page Feature Request: Add Django REST OpenAPI Documentation Page Dec 5, 2020
@VikashKothary VikashKothary changed the title Feature Request: Add Django REST OpenAPI Documentation Page Feature Request: Add REST OpenAPI Documentation Page Dec 5, 2020
@VikashKothary VikashKothary changed the title Feature Request: Add REST OpenAPI Documentation Page Feature Request: Code-first OpenAPI/Swagger Documentation Jun 2, 2021
@VikashKothary
Copy link
Member Author

The hope is to switch over to FastAPI which should do this out-of-the-box (see: #27). But there may be value in doing this in parallel. It wouldn't be code-first but the openapi documentation may be useful to users.

It's important to note that the API is likely to change (see: #22). So it could either be done after this change or before as a way of communicating the change of the API to users.

@VikashKothary VikashKothary changed the title Feature Request: Code-first OpenAPI/Swagger Documentation feat: OpenAPI documentation Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant