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

Add and configure drf-spectacular #1901

Open
rachellougee opened this issue Sep 18, 2023 · 0 comments
Open

Add and configure drf-spectacular #1901

rachellougee opened this issue Sep 18, 2023 · 0 comments

Comments

@rachellougee
Copy link
Contributor

Description/Context

MIT open uses drf-spectacular to generates OpenAPI spec from Django views. @JenniWhitman recommended it for MITx Online as it comes with some features that don't exist in Django rest framework.

Once drf-spectacular is installed, it should works out of the box, but also provides ways to customize the generated OpenAPI schema. Per their docs, It is explicitly designed to work well for documentation (SwaggerUI, ReDoc).

Plan/Design

Note that the existing API won't need to be touched, but if any docstring needs to be updated, please feel free to do so

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

No branches or pull requests

1 participant