File tree Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change @@ -136,6 +136,20 @@ The `rest_framework.documentation` module provides three helper functions to hel
136
136
137
137
There are a number of mature third-party packages for providing API documentation.
138
138
139
+ ---
140
+
141
+ #### drf-yasg - Yet another Swagger generator
142
+ [ drf-yasg] [ drf-yasg ] does not rely on the internal DRF's documenting package, the [ Core API] [ core_api ] .
143
+ The rationale was that the Core API has not been able to generate response schemas ([ issue #4502 ] [ issue_4502 ] ).
144
+
145
+ This is a major issue when a swagger file is the source for code generation, which is typed (for example when using TypeScript).
146
+
147
+ The [ drf-yasg] [ drf-yasg ] solves this problem.
148
+
149
+ The other DRF swagger packages listed below are based on the [ Core API] [ core_api ] . Consequently, they suffer from the same issue.
150
+
151
+ ---
152
+
139
153
#### DRF OpenAPI
140
154
141
155
[ DRF OpenAPI] [ drf-openapi ] bridges the gap between OpenAPI specification and tool chain with the schema exposed
@@ -296,3 +310,6 @@ To implement a hypermedia API you'll need to decide on an appropriate media type
296
310
[ image-self-describing-api ] : ../img/self-describing.png
297
311
[ schemas-examples ] : ../api-guide/schemas/#example
298
312
[ metadata-docs ] : ../api-guide/metadata/
313
+ [ drf-yasg ] : https://github.com/axnsan12/drf-yasg
314
+ [ core_api ] : http://www.django-rest-framework.org/api-guide/schemas/#core-api
315
+ [ issue_4502 ] : https://github.com/encode/django-rest-framework/issues/4502
You can’t perform that action at this time.
0 commit comments