Skip to content

Improve clarity in OpenAPI documentation section #9874

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.

Sign up for GitHub

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

Open
RispaJoseph wants to merge 3 commits into
base: main
Choose a base branch
from
+7 −6
Open

Improve clarity in OpenAPI documentation section #9874

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7b20f4
Fix section title and add note on OpenAPI packages
RispaJoseph Jan 20, 2026
5aab82e
Refine description of API documentation choices
RispaJoseph Jan 20, 2026
c677adc
Use warning admonition for OpenAPI deprecation notice
RispaJoseph Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/topics/documenting-your-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
>
> — Roy Fielding, [REST APIs must be hypertext driven][cite]

REST framework provides a range of different choices for documenting your API. The following
is a non-exhaustive list of the most popular ones.
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.

## 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

Expand Down Expand Up @@ -37,9 +38,9 @@ This also translates into a very useful interactive documentation viewer in the

## Built-in OpenAPI schema generation (deprecated)

**Deprecation notice: REST framework's built-in support for generating OpenAPI schemas is
deprecated in favor of 3rd party packages that can provide this functionality instead.
As replacement, we recommend using the [drf-spectacular](#drf-spectacular) package.**
!!! warning
**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**.


There are a number of packages available that allow you to generate HTML
documentation pages from OpenAPI schemas.
Expand Down
Loading