python - 如何在 Django REST Swagger 2 中记录参数？

Question

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

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

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

score 2 · Accepted Answer

可能是这么晚了，但只是为了一些帮助，你必须重写 Schema 生成器来自定义它，这个文档解释了 django rest swagger 2 的集成一步一步： Django Rest Swagger 2 综合文档

你可能认为它有点hacky，但工作得很好。

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

1 回答 1