如何在 Django REST Swagger 2 中记录参数?



我曾经使用 YAML 文档字符串指定参数,但现在它们已被弃用。我尝试使用coreapi.Field,如下所示:

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

但它仅适用于ViewSet.list,而不适用于ViewSet.create.根据这份报告,这是一个持续存在的问题。评论中提供的解决方案对我来说非常黑客。我希望有人已经找到(或想出)了一个更简洁的解决方案或替代方案,也许是一个插件或其他东西。

可能这太晚了,但只是为了一些帮助,你必须覆盖模式生成器来自定义它,这个文档一步一步地解释了 django rest swagger 2 集成: Django Rest Swagger 2 综合文档

你可能认为它有点笨拙,但工作得很好。

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

最新更新