django 中配置接口文档coreapi

1、接口文档安装依赖:

1、接口文档依赖安装:
    pip install coreapi
如果安装报错:  安装coreapi其它所有的依赖包!
    pip install --upgrade --force-reinstall coreapi
    
包含的库如下:
itypes, urllib3, uritemplate, MarkupSafe, idna, charset_normalizer,
certifi, requests, jinja2, coreschema, coreapi

2、配置

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

3、设置访问路径:

from django.urls import path, include
from rest_framework.documentation import include_docs_urls

urlpatterns = [
    # 设置接口文档访问路径
    path('doc/', include_docs_urls(title='项目的接口文档哦')),
    # ...
]

4、运行项目后查看:

在这里插入图片描述

Logo

腾讯云面向开发者汇聚海量精品云计算使用和开发经验,营造开放的云计算技术生态圈。

更多推荐