You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/topics/documenting-your-api.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,11 @@
4
4
>
5
5
> — Roy Fielding, [REST APIs must be hypertext driven][cite]
6
6
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.
9
8
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.
11
12
12
13
### drf-spectacular
13
14
@@ -37,9 +38,9 @@ This also translates into a very useful interactive documentation viewer in the
**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
+
43
44
44
45
There are a number of packages available that allow you to generate HTML
0 commit comments