首页 > 解决方案 > 在 Django @schema(AutoSchema(manual_fields=

问题描述

我正在使用 django rest api 接收端点中的对象。

有些对象属性是必需的,有些则不是。

我想在文档中显示这一点,但我不知道如何使用手动字段显示对象。

现在我只有对象的名称,例如:

@schema(AutoSchema(manual_fields=[
        coreapi.Field("node", required=True, location="query", description="Node Object")        
    ]))

这在文档中显示如下:

Django 文档

标签: pythondjangodjango-rest-frameworkdjango-views

解决方案


使用 coreschema 设置描述。

from rest_framework.compat import coreschema

coreapi.Field(
    name=name, required=required, location=location, 
    schema=coreschema.String(title=name, description=description)
)

推荐阅读