一键生成drf接口文档

Posted demiao

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了一键生成drf接口文档相关的知识,希望对你有一定的参考价值。

安装模块

pip install coreapi

需要去settings配置

REST_FRAMEWORK = {
	...
    "DEFAULT_AUTHENTICATION_CLASSES": [],
    ‘DEFAULT_SCHEMA_CLASS‘: ‘rest_framework.schemas.coreapi.AutoSchema‘

}

在总路由加

from rest_framework.documentation import include_docs_urls
urlpatterns = [
	...
    url(‘docs/‘, include_docs_urls(title=‘本项目的接口文档‘)),
]

在浏览器访问

http://127.0.0.1:8000/docs/

以上是关于一键生成drf接口文档的主要内容,如果未能解决你的问题,请参考以下文章

drf 生成接口文档

drf之自动生成接口文档

drf 其他功能组件 - 限流-过滤-排序-分页-异常处理-生成接口文档-Xadmin

DRF之文档生成和JWT

drf中自动生成api文档

案例篇:利用ProtoBuf文件,一键生成Java代码