python - View 集中 View 的 Django Rest Framework 自定义模式

Question

我有一个使用 Django 和 Django REST Framework 构建的 API。我有一个模型返回一些不符合典型 Django 模型的构建的 JSON。因此，似乎利用 Django 模型知识的自动文档功能对我的一些观点不起作用。

特别是，我有一个 View 集可以返回一些典型的 API View (如对象列表)，还有一些 View 可以返回我的一些自定义对象。我想为这些自定义对象构建文档，但我不确定如何覆盖 View 集中特定端点的模式。如何覆盖为 DRF View 集中的单个 View 生成的架构？

DRF seems to provide this functionality for views ，但我想对 View 集执行相同的操作。

Answer 1

好的，经过大量的尝试-失败-重试，我终于让它工作了——你失去了一些自动(神奇的)内省(introspection)，比如 id 路径参数和从中获取的描述文档字符串，但我仍然认为这是值得的:

custom_schema = ManualSchema(
    fields=[
        coreapi.Field(
            "id",
            required=True,
            location="path",
            schema=coreschema.String(
                title="ID",
                description="Foobar ID.",
            )
        ),
        coreapi.Field(
            "foobar",
            location="query",
            schema=coreschema.String(
                title="Foobar",
                description="Foobar?",
            )
        ),
    ],
    description="Foobar!",
)


class FoobarViewSet(viewsets.ReadOnlyModelViewSet):

    @action(methods=["get"], detail=True, schema=custom_schema)
    def foobar(self, request, id=None):
        ...