Django restframework 记录视图

Question

我的问题是：

如何填写描述字段？在我的文档页面的 table 参数中，这里是我的函数示例和屏幕截图它看起来如何

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})

Answer 1

DRF 文档在这件事上并不冗长（或者我错过了它所在的部分），但它提到了 rest_framework.schemas.SchemaGenerator class 并且似乎这个 class 确实做了所有的内省东西。幸运的是，源代码是 well-structured 并且易于阅读。

这些路径字段由 get_path_fields method (I found it by tracing the execution path: get_schema → get_links → get_link), and I found that descriptions come from model fields's help_text 属性生成。

所以在我的模型中我指定了：

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

Django restframework 记录视图

Django restframework documenting Views

python

django

documentation-generation

django-rest-framework