DRF-接口文档-(drf自带):drf自动生成接口文档(无需认证过程)

1、安装依赖

pip3 install coreapi

2、在settings.py项目配置文件中:

# drf的配置,全局配置
REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
    'DEFAULT_AUTHENTICATION_CLASSES': [
        # 自己写的认证类
        'studentSystemt.apps.user.authen.MyJWTAuthentication'
    ],
}

3、在项目总路由文件urls.py中:

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    ...
    path('docs/', include_docs_urls(title='站点页面标题', authentication_classes=[]

))
]

#因为我们在项目中配置了自己的认证类。配上authentication_classes=[], 访问docs/路由时,无需走认证过程了。

4、在写视图类的时候,写上注释,

class Books():
    """
    get:获取指定id的书籍信息,需要id
    delete:删除指定id的书籍,需要id
    patch:更新指定id的书籍,需要id和要更新的数据
    """

5、在models写模型类时写上help_text的注释。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值