DRF之自动生成接口文档

目录

• 接口文档
• 自动生成

接口文档

在前后端分离项目中，接口文档是由后端人员编写，前端通过接口文档来获取信息。

接口文档的编写方式有许多：

word文档编写

使用word文档编写。

接口文档平台

公司可能会有自己的接口文档平台，后端人员在文档平台录入数据。

自己搭建接口文档平台：https://zhuanlan.zhihu.com/p/366025001

第三方平台：比如 https://www.showdoc.com.cn/

自动生成接口文档

DRF提供了自动生成接口文档的模块。

自动生成

安装模块：

pip install coreapi

路由添加：

from rest_framework.documentation import include_docs_urls
urlpatterns = [
    # 地址随意，我们之后需要通过地址访问接口文档
    path('docs/', include_docs_urls(title='站点页面标题'))
]

配置文件添加：

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}

接下来就编写各种接口。比如下面是我的一个视图类：

最后访问接口文档的路由：