如何为Django REST Framework文档编写响应模式？

Question

3

我正在使用默认的DRF文档API记录自定义端点。该端点的输出相当复杂，我需要以漂亮的方式将其显示给前端开发人员在文档API中。目前的解决方案是使用方法的docstring，但这并不太好看。

有一种干净的方法可以使用模式描述输入参数，但我找不到描述输出模式的示例。

官方文档中有一个截图，表明这是可能的（注意图片中的响应模式），但不幸的是没有示例。

- SS_Rebelious

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- twelve40 · Answer 1

我也在寻找同样的功能，但似乎大部分响应内容都是自动生成的，我们很难对其进行控制。例如，我的设置一直坚持所有POST请求必须返回201状态码，无法自定义响应体，只能使用它指定的创建POST对象的某个对象。

最终选择使用drf-yasg，它非常易于入手且可以指定响应，例如： user_response = openapi.Response('响应描述', UserSerializer)