问候大家！
在这篇文章中，我会告诉您，我们如何为任何Django Rest Framework项目生成API文档，不到一分钟！
！如果这听起来很有趣，请沿着
遵循步骤1：安装DRF_YASG软件包
注意：您可能会找到其他用于自动生成API文档的软件包，但是其中大多数已过时并且不维护，这就是为什么我建议您坚持使用
drf_yasg
让我们从将drf_yasg软件包安装到您的本地开发环境中
(env) $ pip install drf_yasg
安装软件包后，将其包含在INSTALLED_APPS数组中，在您的settings.py文件中
# settings.py
...
INSTALLED_APPS = [
# other packages
'drf_yasg'
]
...
使用此drf_yasg将安装在您的django项目中
步骤2：更新您的根网址文件
安装软件包后，打开项目的root urls.py文件
/mydjangoproject
|-mydjangoproject
| |-__init__.py
| |-wsgi.py
| |-asgi.py
| |-urls.py # <---- This file
| |-settings.py
|-app1
|-app2
打开后，使用以下代码进行更新 -
# existing imports
...
# import get_schema_view and openapi from drf_yasg
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
# create the schema view
schema_view = get_schema_view(
openapi.Info(
title="My Django APIs",
default_version='v1',
description="Creating API docs was never this easy!!",
),
public=True
)
# include the schema_view in the urlpatterns
urlpatterns = [
# existing routes
...
path('docs', schema_view.with_ui('swagger', cache_timeout=0)),
path('redoc', schema_view.with_ui('redoc', cache_timeout=0)),
]
已经完成了，现在打开127.0.0.1:8000/docs路线，您会看到所有API的Swagger页面！
如果您想要重做版本，只需转到127.0.0.1:8000/redoc页面，RETOC API文档将出现在那里！
Swagger页面
如果您有任何问题，请在注释上提及它们 欢呼！