encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2026-01-27 18:45:58 +03:00
Code Issues Packages Projects Releases Wiki Activity

Clarify deprecation of built-in OpenAPI documentation (#9874)

Browse Source
This commit is contained in:
Rispa Joseph 2026-01-24 19:42:00 +05:30 committed by GitHub
parent 9da0ce25b7
commit c8af56d260
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/topics/documenting-your-api.md
View File

@ -4,10 +4,11 @@
> >
> — Roy Fielding, [REST APIs must be hypertext driven][cite] > — Roy Fielding, [REST APIs must be hypertext driven][cite]
REST framework provides a range of different choices for documenting your API. The following REST framework provides a range of different choices for documenting your API. The following is a non-exhaustive list of some of the most popular options.
is a non-exhaustive list of the most popular ones.
## Third party packages for OpenAPI support ## Third-party packages for OpenAPI support
REST framework recommends using third-party packages for generating and presenting OpenAPI schemas, as they provide more features and flexibility than the built-in (deprecated) implementation.
### drf-spectacular ### drf-spectacular
@ -37,9 +38,9 @@ This also translates into a very useful interactive documentation viewer in the
## Built-in OpenAPI schema generation (deprecated) ## Built-in OpenAPI schema generation (deprecated)
**Deprecation notice: REST framework's built-in support for generating OpenAPI schemas is !!! warning
deprecated in favor of 3rd party packages that can provide this functionality instead. **Deprecation notice:** REST framework's built-in support for generating OpenAPI schemas is deprecated in favor of third-party packages that provide this functionality instead. As a replacement, we recommend using **drf-spectacular**.
As replacement, we recommend using the [drf-spectacular](#drf-spectacular) package.**
There are a number of packages available that allow you to generate HTML There are a number of packages available that allow you to generate HTML
documentation pages from OpenAPI schemas. documentation pages from OpenAPI schemas.