Django Rest Framework 文档化视图

Question

我的问题是：

如何填写参数表中的“描述”字段？以下是我函数的示例和屏幕截图，展示了填写该字段的样例。

def delete(self, request, id_):
    repository = self.get_object(id_, owner=request.user)
    repository.delete()
    return Response(status=status.HTTP_204_NO_CONTENT, headers={"web_words": request.user.profile.web_words, "repo_words": request.user.profile.repo_words, "files": request.user.profile.files})

- Rodrigo Espinoza

---

这是您要找的内容吗？（链接为 https://dev59.com/GFcP5IYBdhLWcg3w5d_Q） - webbyfox

可能是DRF文档中如何描述参数的问题的重复。 - webbyfox

Answer 1

DRF文档并没有详细说明这个问题（或者我错过了相关部分），但是它提到了rest_framework.schemas.SchemaGenerator类，看起来这个类确实完成了所有内省工作。幸运的是，源代码结构良好且易于阅读。

这些路径字段是由get_path_fields方法生成的（我通过跟踪执行路径找到了它：get_schema→get_links→get_link），我发现描述信息来自模型字段的help_text属性。

因此，在我的模型中，我已经指定了：

class MyResource(models.Model):
    slug = models.CharField(unique=True, help_text=_("unique alphanumeric identifier"))
    ...

- webbyfox

---

我正在尝试使用以下代码：slug = models.CharField(unique=True, help_text=_("unique alphanumeric identifier"))。但是，如果我的函数非常定制化，则只有help_text=("unique description")在没有_的情况下才能正常运行。 - Rodrigo Espinoza

你需要导入_，并将其作为别名导入from django.utils.translation import ugettext_lazy as _。 - webbyfox