Django restframework记录视图

问题描述 投票:4回答:1

我的问题是:

我怎么能填写字段描述?在我的文档页面的参数表中,这里是我的函数示例和屏幕截图的外观

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

enter image description here

python django django-rest-framework documentation-generation
1个回答
2
投票

DRF文档在这个问题上并不详细(或者我错过了它的位置),但是它提到了rest_framework.schemas.SchemaGenerator class,看起来这个类真的做了所有内省的东西。幸运的是,源代码结构良好且易于阅读。

那些路径字段是由get_path_fields方法生成的(我通过跟踪执行路径找到它:get_schemaget_linksget_link),我发现描述come from model fields's help_text属性。

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

class MyResource(models.Model):
    slug = models.CharField(unique=True, help_text=_("unique alphanumeric identifier"))
    ...
© www.soinside.com 2019 - 2024. All rights reserved.