Skip to main content
 首页 » 编程设计

python之如何记录 Django REST Swagger 2 中的参数

2024年10月01日36davidwang456

我曾经使用 YAML Docstring 指定参数,但现在已弃用它们。我试过使用coreapi.Field,如下:

coreapi.Field( 
    name='id', 
    type='integer', 
    required=True, 
    location='query' 
) 

但它只适用于ViewSet.list,而不适用于ViewSet.create。根据this report ,这一直是一个持续的问题。评论中提供的解决方案对我来说非常骇人听闻。我希望有人已经找到(或提出)更简洁的解决方案或替代方案,也许是插件或其他东西。

请您参考如下方法:

可能已经太晚了,但为了获得一些帮助,您必须重写 Schema 生成器以对其进行自定义,此文档逐步解释了 django rest swagger 2 集成: Django Rest Swagger 2 comprehensive documentation

您可能认为它有点老套,但效果非常好。

编辑:此文档可用于基于函数的 View ,但如果您已经有基于类的 View ,则可以直接使用此包:https://drf-yasg.readthedocs.io/en/stable/readme.html