我正在使用默认 DRF 文档 API 记录自定义端点。端点的输出非常复杂,我需要一种漂亮的方式在文档 API 中将其显示给前端开发人员。当前的解决方案是使用不太漂亮的方法的文档字符串。
有一种使用 schema
来描述输入参数 的简洁方法,但我无法找到描述输出模式的示例。
官方文档中有截图表明这是可能的(注意图片中的response schema
),但遗憾的是没有示例。
最佳答案
我一直在寻找相同的功能,但似乎大部分响应内容都是自动生成的,几乎无法控制。例如,我的设置一直坚持我的所有 POST 都必须返回 201,并且无法指定自定义响应主体,只是它决定此 POST 创建的一些对象。
最终改用 drf-yasg
,它非常容易上手并且 specify responses ,例如:
user_response = openapi.Response('响应描述', UserSerializer)
关于django - 如何记录 Django REST Framework 文档的响应模式?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/50717270/