Django restframework记录视图

时间:2018-03-01 12:50:01

标签: python django django-rest-framework documentation-generation

我的问题是:

我该如何填写字段说明?在我的文档页面中的参数表中,这里是我的函数示例和截图它看起来如何

from xml.dom.minidom import parse
dom = parse('C:\Users\qxn5622\Desktop\EF10018\DEFAULT.tbc')

propertyList = dom.getElementsByTagName('PROPERTY')
for prop in propertyList:
    if prop.getAttribute('name') == "PrjFile":
        myString = prop.getElementsByTagName("VALUE")
        print myString[0].firstChild.nodeValue

enter image description here

1 个答案:

答案 0 :(得分:2)

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

这些路径字段是由get_path_fields方法生成的(我通过跟踪执行路径找到它:get_schemaget_linksget_link),我发现了这些描述{ {3}}属性。

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

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