使用django API的drf-spectacular定义组件模式

9jyewag0 于 2023-06-25 发布在 Go

关注(0)|答案(2)|浏览(332)

我正在使用drf-spectacular为django生成一个OpenAPI模式。因为我没有使用序列化器，所以我在extend_schema装饰器中定义了所有内容。现在我的问题是，是否可以手动定义组件模式。
下面是我的API视图的一个例子：

from rest_framework.decorators import api_view
from drf_spectacular.utils import (extend_schema, OpenApiExample)
from drf_spectacular.types import OpenApiTypes
from rest_framework.response import Response

@extend_schema(
    examples=[OpenApiExample(
        value=[
            {'title': 'A title'},
            {'title': 'Another title'},
        ],
    )],
    responses={
       200: OpenApiTypes.OBJECT
    }
)
@api_view(['GET'])
def list_articles(request):
    return Response([{'title': 'Test1'}, {'title': 'Test2'}])

并且相应的组件被示出为空（例如， Swagger ）：

Here是文档中的定义，但我不知道如何使用drf-spectacular实现它。

django

来源：https://stackoverflow.com/questions/69482097/define-component-schema-with-drf-spectacular-for-django-api

2条答案

按热度按时间

5lhxktic1#

OpenApiTypes.OBJECT表示响应对象可以有任意数量的字段。当然，Swagger UI无法提前知道这些字段，因此它显示{}，这可能不直观，但它是正确的。
你想要的是给予你的回答一些结构。Spectacular中的一切都围绕着序列化器/组件。如果不想使用显式序列化程序，可以使用inline_serializer创建隐式序列化程序

from drf_spectacular.utils import extend_schema, OpenApiExample, inline_serializer

@extend_schema(
    examples=[OpenApiExample(
        value=[
            {'title': 'A title'},
            {'title': 'Another title'},
        ],
    )],
    responses={
       200: inline_serializer(
           name='Article',
           fields={
               'title': serializers.CharField(),
           }
       )
    }
)
@api_view(['GET'])
def list_articles(request):
    pass

赞(0）回复(0）举报 2023-06-25

gz5pxeao2#

也可以使用简单的字典代替inline_serializer：

@extend_schema(
    ...
    responses={
        (200, 'text/html'): {
            'description': 'Simple HTML page',
            'type': 'string',
            'example': '<html>Example text</html>'
        },
        (202, 'application/json'): {
            'description': 'JSON response',
            'type': 'object',
            'properties': {
                'title': {
                    'type': 'string',
                    'minLength': 1,
                    'maxLength': 128
                }
            },
            'required': [
                'title'
            ]
        },
    }
)
...

赞(0）回复(0）举报 2023-06-25

我来回答

使用django API的drf-spectacular定义组件模式

2条答案

相关问题

热门标签

最新问答