django rest framework 自定义额外的参数

一个好的Django专题少不了您的贡献:点我进入专题

自动生成的API文档参数不够用?自己造作呀~(如果有更好的实现欢迎投稿)


效果图

GET 有两个方法(list(path:/api/mall/)与retrieve(path:/api/mall/{id}/)生成的),所以and双重判断路径

官方教程地址: autoschema

from ..mlogger import mlogger # 自定义的日志过滤器
import coreapi
from rest_framework.schemas import AutoSchema
# 自定义额外的参数
class MallViewSchema(AutoSchema):
    def get_manual_fields(self, path, method):
        mlogger.info('path:' + path)
        mlogger.info('method:' + method)
        extra_fields = []
        if method == 'GET' and path == '/api/mall/':
            extra_fields = [
                coreapi.Field(
                    "sss",
                    required=False,
                    location="path",
                    description='Cissty',
                ),
            ]
        manual_fields = super().get_manual_fields(path, method)
        return manual_fields + extra_fields
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。