python - Django rest 框架文档 View

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

Answer 1

DRF 文档在这个问题上并不冗长(或者我错过了它所在的部分)，但它提到了 rest_framework.schemas.SchemaGenerator class看起来这个类确实做了所有的内省(introspection)工作。幸运的是，源代码结构良好且易于阅读。

这些路径字段由 get_path_fields 生成方法(我是通过跟踪执行路径找到的:get_schema → get_links → get_link)，发现描述come from model fields's help_text属性。

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

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