DRF自动生成接口文档

自动接口文档能生成的是继承自APIView及其子类的视图。

1. 安装依赖

#　生成接口文档需要coreapi库的支持
pip install coreapi

2 设置接口文档访问路径

# 在总路由中添加接口文档路径
from rest_framework.documentation import include_docs_urls
urlpatterns = [
    path('docs/', include_docs_urls(title='My API title'))
]

3 参数配置

• title：指定API文档的标题。
• description：可选参数，用于提供API文档的描述信息。
• schema_url：可选参数，用于指定用于生成文档的URL模式。

4 访问接口文档网页

浏览器访问 127.0.0.1:8000/docs/，即可看到自动生成的接口文档。