3.DjangoRestFramework【API文档的使用】

在开发中需要前端后端开发人员实现约定数据接口的地址、类型、参数、返回值等。
口头协定肯定不行。
需要有API文档。
DRF自带了一套自动生成API文档的工具(有点专业)。
使用流程:

1.安装coreapi

pip install coreapi

2.添加API文档路由

在根目录下的url中添加API路由

# 引入API文档路由
from rest_framework.documentation import  include_docs_urls
urlpatterns = [
 ...
 # 在项目路由中添加API地址
    path('api/v1/docs',include_docs_urls(title="RestFulAPI",description="RestFulAPI v1")),
...
]

3.指定主题

会出现错误:
'AutoSchema' object has no attribute 'get_link'
可以直接修改Django配置文件添加以下内容:
因为jangoRestFramWork对中默认的配置是使用了AutoSchema,我们可以在自己的setting中对其重新配置:

REST_FRAMEWORK={
    # Schema
    'DEFAULT_SCHEMA_CLASS':'rest_framework.schemas.AutoSchema'
}

4.使用API文档

将系统地址输入进浏览器,点击查看API文档
进入API文档,就可以查看到对应的增删改查的路由地址,交互按钮就可以模拟使用这个功能