REST framework:接口文档的配置与生成

REST framework通过第三方库可以自动帮助我们生成网页版的接口文档，自动接口文档能生成的是继承自APIView及其子类的视图

1、安装依赖

REST framewrok生成接口文档需要coreapi库的支持

 

pip install coreapi -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host mirrors.aliyun.com

2、注册应用

在项目settings注册应用，配置如下

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    # 注册应用
    'coreapi',
]

3、进行接口文档设置

在项目settings文件，配置如下

REST_FRAMEWORK = {
    # 接口文档配置
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
   }

4、设置接口文档访问路径

在项目路由中添加接口文档的路由，配置如下

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    re_path(r'^docs/', include_docs_urls(title='接口文档'))

]

 

启动Django项目，浏览器访问 127.0.0.1:8000/docs/，即可看到自动生成的接口文档