Django之Swagger接口文档生成(四)

传送门：

Django之安装(一)

Django之创建项目与配置(二)

Django之添加API(三)

Django之Swagger接口文档生成(四)

Django之Restful接口测试-Postman(五)

Django之Restful接口测试-Python+Requests+Unittest(六)

Django之Restful接口测试-Django自带测试模块(七)

Swagger接口文档生成

接口开发完成了，那么接下来需要编写接口文档。传统的接口文档编写都是使用word或者其他一些接口文档管理平台，这种形式接口文档维护更新比较麻烦，每次接口有变动时得手动修改文档。因此，针对这种情况，这里推荐使用Swagger来管理接口文档。

Django 接入 Swagger

1. 输入以下命令安装Swagger

pip install django-rest-swagger

2. 进入 seeting.py 添加 rest_framework_swagger 应用

3. 在 urls.py 添加 get_schema_view 辅助函数

from rest_framework.schemas import get_schema_view
from rest_framework_swagger.renderers import SwaggerUIRenderer,OpenAPIRenderer

schema_view=get_schema_view(title='API',renderer_classes=[OpenAPIRenderer,SwaggerUIRenderer])

urlpatterns = [
    path('admin/', admin.site.urls),
    path('',include(router.urls)),
    path('api-auth/',include('rest_framework.urls',namespace='rest_framework')),
    path('docs/',schema_view,name='docs')
]

4. 启动服务，浏览器访问 http://127.0.0.1:8000/docs/ 即可看到以下界面
   
5. 分别点击 goups 与 users 即可看到自动生成的接口文档