自定义request_经验总结: drf-yasg接口文档几个细节的自定义方式

最新推荐文章于 2024-08-12 08:59:34 发布

光明与希望

最新推荐文章于 2024-08-12 08:59:34 发布

阅读量817

点赞数

文章标签：自定义request

本文链接：https://blog.csdn.net/weixin_36252618/article/details/112719561

版权

本文介绍了在Django RestFramework使用drf-yasg扩展生成OpenApi接口时，如何自定义请求参数和接口说明，以及如何为每个分组添加说明，通过代码示例展示了实现过程，旨在优化接口文档的细节，提高开发协作效率。

摘要由CSDN通过智能技术生成

drf-yasg是Django RestFramework的一个扩展, 可以根据路由生成OpenApi接口, 不过用起来和在Java平台和.NetCore有很多不一样的, 有些自定义的地方也比较麻烦, 不过看看文档也还好, 可以解决.

本文记录几个在实际开发中遇到的, 虽然是细节, 但是优化好细节可以给对接的同事带来很大的方便~

顺带一提, Python写后台真的太快了, 一上午出几十个接口你能信?

设置请求参数和接口说明

实现代码

@swagger_auto_schema(request_body=openapi.Schema(
    type=openapi.TYPE_OBJECT,
    required=['phone'],
    properties={
    'phone': openapi.Schema(type=openapi.TYPE_STRING)}
), operation_summary='更新手机号码')
@action(detail=True, methods=['PUT'], permission_classes=[permissions.IsAuthenticated])
def phone(self, request, pk=None):
    """更新手机号码"""
    if request.method == 'POST':
        phone_num = request.data.get('phone')
        profile_obj: UserProfile = get_object_or_404(UserProfile.objects.all(),