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

【问题标题】：How to document parameters in Django REST Swagger 2?如何在 Django REST Swagger 2 中记录参数？
【发布时间】：2017-05-12 12:30:02
【问题描述】：

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

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

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

【问题讨论】：

【解决方案1】：

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

你可能会觉得它有点老套，但效果很好。

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

【讨论】：

也许我的想法都错了，但是这些步骤是不是太多了？我已经创建了我的模型，我已经创建了我的序列化程序，我已经创建了我的视图，为什么我必须移动天地来显示字段？为什么大摇大摆的人不能自动跟进并拿起这些字段？
该文档是针对基于函数的视图，如果您已经编写了基于类，那么您应该直接使用这个更新的包：drf-yasg.readthedocs.io/en/stable/readme.html