Skip to content

Conversation

@keshav-space
Copy link
Member

@keshav-space keshav-space commented Dec 6, 2023

Use drf-spectacular for swagger flavour API Documentation.

Why use drf-spectacular over DRF's Built-in Documentation?

  • Built-in Documentation depends on CoreAPI and starting v3.10 DRF began deprecating CoreAPI in favor of OpenAPI [Ref]
  • Starting v3.14 DRF began deprecating Built-in support for OpenAPI schema in favor of 3rd party packages like drf-spectacular [Ref]
  • fixes Create API documentation #225
Screenshots
Screenshot from 2024-02-07 20-09-34
Screenshot from 2024-02-07 20-10-11

@keshav-space keshav-space marked this pull request as draft December 6, 2023 18:25
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
@keshav-space keshav-space marked this pull request as ready for review December 12, 2023 21:15
@pombredanne
Copy link
Member

@keshav-space we should merge this soon enough! do you mind rebasing?

@pombredanne
Copy link
Member

Also would have a screenshot that shows up how to use it? And/or some simple instructions and a Changelog entry?

Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
@JonoYang
Copy link
Member

@keshav-space Thanks!

@JonoYang JonoYang merged commit ed53bcf into main Feb 12, 2024
@JonoYang JonoYang deleted the 225-api-doc branch February 12, 2024 18:50
JonoYang added a commit that referenced this pull request Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create API documentation

4 participants