blue_krill帮你更好处理swagger传输数据

在之前的swagger快速入门文章:

http://t.csdn.cn/GUdZ1 中讲解了swagger的基本使用,这里介绍一个十分简洁有力的工具:

        blue_krill 是腾讯蓝鲸智云(BlueKing)提供的一个 Python 工具库

        在安装 blue_krill 就可以使用装饰器 inject_serializer ,相比于原始 Swagger 的方法手动编写  Swagger 文档,使用 inject_serializer 能够更方便地从 DRF 序列化器生成文档。

原始设置部分就按原本Swagger的设置,下SDK,配APP,配URL三步走。

原始设置参考以下这个文档,本篇介绍比使用 @swagger_auto_schema 更妙的方式
Swagger文档注释http://t.csdn.cn/GUdZ1

        下载SDK:

pip install blue_krill

        以下语句方式,便可从 blue_krill 库中导入 inject_serializer 装饰器。

from blue_krill.web.drf_utils import inject_serializer

        然后使用方法类似 swagger_auto_schema 但是序列化字段可直接用序列化器去实现,会方便整洁很多。

        可以看看这个装饰器的源码注解:

def inject_serializer(
    body_in: Optional[Union[Type[BaseSerializer], BaseSerializer]] = None,
    query_in: Optional[Union[Type[BaseSerializer], BaseSerializer]] = None,
    out: Optional[Union[Type[BaseSerializer], BaseSerializer]] = None,
    config: Optional[dict] = None,
    **swagger_kwargs
):
    """
    Sugar for simpling drf serializer specification
    :param body_in: input serializer (request body)
    :param query_in: input serializer (query)
    :param out: output serializer
    :param config: initial info of Config
    :param swagger_kwargs: pass to swagger_auto_schema of drf-yasg
    """

        比较通用的使用方法:

    @inject_serializer(
        query_in=序列化器1,
        body_in=序列化器1,
        out=序列号器2,
        tags=["区分视图"],
        operation_summary="区分方法",
    )

        请求体用body,URL请求用query即可。生成方法会自动生成入 Swagger文档。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值