Bootstrap

django中的DRF框架的coreapi和swagger自动生成接口文档

一、第一种文档:coreapi

REST框架可以⾃动帮助我们⽣成接⼝⽂档。

⾃动接⼝⽂档能⽣成的是继承⾃APIView及其⼦类的视图。

1.安装依赖

pip install coreapi

2.在settings配置DEFAULT_SCHEMA_CLASS

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

3.设置接⼝⽂档访问路径

        在总路由中添加接⼝⽂档路径。

from rest_framework.documentation import include_docs_urls

urlpatterns = [
     path('docs/', include_docs_urls(title='My API title')),  # coreapi接口文档
]

4.⽂档描述说明的定义位置

1)单⼀⽅法的视图,可直接使⽤类视图的⽂档字符串,如

 2)包含多个⽅法的视图,在类视图的⽂档字符串中,分开⽅法定义,如

;