Django_coreapi生成接口文档(djangorf的，写注释更方便）

1.coreapi简介

• 可以生成接口文档
• 自动生成测试代码（coreapi库的）
• 支持在线接口测试

2.安装第三方库

pip install coreapi
Pygments(可选)
Markdown(可选）

3.配置文件中添加配置

在settings.py文件中

REST_FRAMEWORK = {
    # 指定用于支持coreapi的Schema
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}

4. urls文件中添加路径

在urls.py 中添加文档路径,  (在外层url文件，或应用内的都行)

#2. coreapi文档需要进行的导入信息
from rest_framework.documentation import include_docs_urls

urlpatterns = [
   #3. coreapi文档路径
    path('docs/',include_docs_urls(title="接口测试平台API文档",
                                   description="这个是接口平台的文档"
                                   ))
]

4.1 注册应用

当然需要把rest_framework注册到setting中的app，不然要报错

5.配置各接口的说明

一种方式是写在类下面（下面第二张图），格式：

另一种方式，三个字符串注释，写在方法下面（优先级更优先）

"""

方法名：描述

"""

模型中定义的verbose_name 和  help_text 也会被用到