feat(backend): generate OpenAPI v3 swagger docs #5259
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Akuukis
force-pushed
the
kalvis/swagger
branch
from
4e2fe1e to
be3c033
Compare
Akuukis
commented
Nov 13, 2024
| @@ -58,7 +58,7 @@ def filter_renderers(self, renderers, format): | |||
|
|
|||
| class MediaFileRenderer(BaseRenderer): | |||
| media_type = '*/*' | |||
| format = None | |||
| format = 'TODO' | |||
There was a problem hiding this comment.
drf_spectacular requires format to be a string, otherwise it crashes. What would the right format here?
Akuukis
commented
Nov 13, 2024
| @@ -24,7 +24,7 @@ class AssetJsonRenderer(renderers.JSONRenderer): | |||
|
|
|||
| class MediaFileRenderer(renderers.BaseRenderer): | |||
| media_type = '*/*' | |||
| format = None | |||
| format = 'TODO' | |||
There was a problem hiding this comment.
drf_spectacular requires format to be a string, otherwise it crashes. What would the right format here?
Akuukis
commented
Nov 13, 2024
Comment on lines
+23
to
+33
| path('api/schema/', SpectacularAPIView.as_view(), name='schema'), | ||
| path( | ||
| 'api/schema/swagger/', | ||
| SpectacularSwaggerView.as_view(url_name='schema'), | ||
| name='swagger-ui', | ||
| ), | ||
| path( | ||
| 'api/schema/redoc/', | ||
| SpectacularRedocView.as_view(url_name='schema'), | ||
| name='redoc', | ||
| ), |
There was a problem hiding this comment.
I just copied the example from docs for a quick PoC. Questions:
- what api path you'd like?
- is this the right
urls.pyto add spectacular to urls? - let's use swagger or redoc, or both? My preference is swagger.
Akuukis
force-pushed
the
kalvis/swagger
branch
3 times, most recently
from
6f27d32 to
c242689
Compare
Akuukis
force-pushed
the
kalvis/swagger
branch
from
c242689 to
eec41c2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗒️ Checklist
<type>(<scope>)<!>: <title> TASK-1234frontendorbackendunless it's global📣 Summary
Automatically generate and display API schema.
📖 Description
Automatically generate OpenAPI v3 schema and display it in both swagger and redoc. See urls:
👀 Preview steps
💭 Notes
The schema most likely is not complete nor accurate. The scope of this PR is auto-generate schema as-is as a starting point, to enable iteration and improvement of the schema over time.
The purpose of auto-generated schema is twofold:
I considered three options for schema generation:
Reviewers, please help me to pack this properly for merging, this PR is rough like a quick PoC.
Screenshots of swagger and redoc: