Skip to content

Commit c8af56d

Browse files
authored
Clarify deprecation of built-in OpenAPI documentation (#9874)
1 parent 9da0ce2 commit c8af56d

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/topics/documenting-your-api.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
>
55
> — Roy Fielding, [REST APIs must be hypertext driven][cite]
66
7-
REST framework provides a range of different choices for documenting your API. The following
8-
is a non-exhaustive list of the most popular ones.
7+
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.
98

10-
## Third party packages for OpenAPI support
9+
## Third-party packages for OpenAPI support
10+
11+
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.
1112

1213
### drf-spectacular
1314

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

3839
## Built-in OpenAPI schema generation (deprecated)
3940

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

4445
There are a number of packages available that allow you to generate HTML
4546
documentation pages from OpenAPI schemas.

0 commit comments

Comments
 (0)