Django之DRF-生成接口文档和swagger

一、功能简介

• 生成API文档平台
• 自动生成测试代码
• 支持接口测试

二、安装

• coreapi（必须）
• Pygments（可选）
• MarkDown（可选

三、使用coreapi

1.最新版的DRF（>3.10）中，需要在全局配置文件settings.py中添加如下配置,可在DRF中查看版本

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

2.在全局路由配置文件中配置：

urlpatterns = [
    path('docs/', include_docs_urls(title='测试平台接口文档'))
]

3.添加注释

3-1.单一方法的视图

直接给视图添加注释

class ProjectsListView(ListAPIView):
"""
返回所有项目信息
"""

3-2.多个方法的视图