【DRF配置管理】如何建立coreapi风格接口文档

原创

已于 2023-06-14 09:58:39 修改 · 1.3k 阅读

1 ·

CC 4.0 BY-SA版权

您的关注是我的荣幸

文章标签：

#python #django #开发语言

于 2023-04-25 11:36:16 首次发布

本文介绍了如何在Django中使用DRF框架，包括安装coreapi，配置REST_FRAMEWORK参数，实现JWT身份验证，使用序列化处理验证码、注册和登录，以及如何进行ORM查询。此外，还详细讲解了如何构建排序、模糊搜索和范围查询功能，使用视图类和get_objects()方法，以及如何实现RBAC权限控制，创建coreapi和swagger风格的API接口文档。

原文作者：我辈李想
版权声明：文章原创，转载时请务必加上原文超链接、作者信息和本声明。

DRF应用和管理

【DRF配置管理】Django安装DRF框架并生成openapi风格文档
【DRF配置管理】如何实现JWT身份验证
【DRF配置管理】如何使用序列化:验证码、注册和登录
【DRF配置管理】如何结合ORM实现排序、模糊搜索、范围查询
【DRF配置管理】如何在视图类使用get_objects()
【DRF配置管理】如何实现RBAC页面菜单和按钮权限
【DRF配置管理】如何建立coreapi风格api接口文档
【DRF配置管理】如何建立swagger风格api接口文档

前言

DRF广泛的应用于django网络开发，尤其是在前后端分离的项目中，与vue、react等框架结合使用。本篇博客单独介绍DRF自带接口文档的使用。

一、coreapi安装

这个库需要安装。

pip install coreapi

二、REST_FRAMEWORK参数

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

三、urls路由配置

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

四、视图注释显示

这里的注释一般是在类视图，主要跟继承的方法有关，本博客以ModelViewSet为例，示例如下:

class PicDatasView(ModelViewSet):
    """
    list:
    不带路径参数获取全部
    create:
    新增一条记录
    retrieve:
    带路径参数获取一条
    up

最低0.47元/天解锁文章