如何在django rest swagger中呈现参数?

时间:2017-08-18 16:42:21

标签: django django-rest-framework django-swagger

我用django rest框架和django rest swagger编写Web API。

  • django-rest(0.0.1)
  • django-rest-swagger(2.1.2)
  • djangorestframework(3.6.3)

我尝试在view方法或APIView方法中编写Swagger YAML。方法功能没问题,功能描述也没问题。但无法呈现GET / POST方法参数。

view方法不使用任何数据库模型,而是使用自定义模型。

  • 如何在参数部分中呈现自定义模型字段。
  • 如何在Swagger UI参数部分中呈现POST正文。
  • 无法呈现参数部分,如何显示它。

P.S。如果我用 coreapi.Document 编写页面,则可以很好地呈现参数。但这种方式对于API文档而言过于复杂。希望YAML在APIView方法或ViewSet方法上没问题。

2 个答案:

答案 0 :(得分:0)

Swagger实际上会读取与该网址相关联的视图,并检查其用于哪种方法, 如果是CreateAPIView(发布),则将显示相对于该URL的POST方法,然后使用该特定视图搜索分配的序列化程序,然后从中选择关联模型的输入字段。因此,如果您的情况一切正常,请分步进行。

答案 1 :(得分:0)

如果使用视图集,则从GenericViewSet继承。