时间戳

首页 > 解决方案 > 如何记录 Django REST Framework 文档的响应模式？

django - 如何记录 Django REST Framework 文档的响应模式？

问题描述

我正在使用默认 DRF 文档 API 记录自定义端点。端点的输出非常复杂，我需要一种漂亮的方式在文档 API 中将其显示给前端开发人员。当前的解决方案是使用不那么漂亮的方法的文档字符串。

有一种使用 描述输入参数的简洁方法，但schema我找不到描述输出模式的示例。

官方文档中有截图表明这是可能的（注意response schema图片中的a），但不幸的是没有示例。

在此处输入图像描述

标签： djangopython-3.xdjango-rest-frameworkdocumentation

解决方案

我一直在寻找相同的功能，但似乎大多数响应内容都是自动生成的，几乎无法控制。例如，我的设置一直坚持我的所有 POST 必须返回 201，并且无法指定自定义响应正文，只是它决定此 POST 正在创建的一些对象。

最终drf-yasg改用，它非常容易上手并指定响应，例如： user_response = openapi.Response('response description', UserSerializer)

推荐阅读