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

本文介绍了如何在Django REST Framework(DRF)中利用coreapi和swagger自动生成接口文档。首先,讲解了coreapi的安装、配置、文档描述定义以及如何访问生成的接口文档。在视图和ViewSet中定义文档字符串,通过help_text为模型字段添加描述。接着,讨论了swagger的集成,包括依赖安装、设置文档路径,并提及swagger如何支持JWT自动认证。
摘要由CSDN通过智能技术生成

一、第一种文档: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)包含多个⽅法的视图,在类视图的⽂档字符串中,分开⽅法定义,如

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值