1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
|
from unittest import mock
from django.utils.http import urlsafe_base64_encode
from rest_framework import mixins, serializers, viewsets
from rest_framework.decorators import action, api_view
from rest_framework.response import Response
from drf_spectacular.openapi import AutoSchema
from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import (
OpenApiParameter, extend_schema, extend_schema_field, extend_schema_serializer,
)
from tests import assert_schema, generate_schema, get_response_schema
class AlphaSerializer(serializers.Serializer):
field_a = serializers.CharField()
field_b = serializers.IntegerField()
class BetaSerializer(AlphaSerializer):
field_c = serializers.JSONField()
class DeltaSerializer(serializers.Serializer):
field_a = serializers.CharField(required=False)
field_b = serializers.IntegerField(required=False)
@extend_schema_field(OpenApiTypes.BYTE)
class CustomField(serializers.Field):
def to_representation(self, value):
return urlsafe_base64_encode(b'\xf0\xf1\xf2') # pragma: no cover
@extend_schema_field(OpenApiTypes.BYTE)
class CustomURLField(serializers.URLField):
def to_representation(self, value):
return urlsafe_base64_encode(b'\xf0\xf1\xf2') # pragma: no cover
@extend_schema_serializer(component_name='GammaEpsilon')
class GammaSerializer(serializers.Serializer):
encoding = serializers.CharField()
image_data = CustomField()
custom_url_field = CustomURLField()
class InlineSerializer(serializers.Serializer):
inline_b = serializers.BooleanField()
inline_i = serializers.IntegerField()
class QuerySerializer(serializers.Serializer):
stars = serializers.IntegerField(min_value=1, max_value=5, help_text='filter by rating stars')
contains = serializers.CharField(
min_length=3, max_length=10, help_text='filter by containing string', required=False
)
order_by = serializers.MultipleChoiceField(
choices=['a', 'b', 'c'],
default=['a'], # type: ignore
)
tag = serializers.CharField(required=False)
class ErrorDetailSerializer(serializers.Serializer):
field_i = serializers.SerializerMethodField()
field_j = serializers.SerializerMethodField()
field_k = serializers.SerializerMethodField()
field_l = serializers.SerializerMethodField()
field_m = serializers.SerializerMethodField()
@extend_schema_field(OpenApiTypes.DATETIME)
def get_field_i(self, object):
return '2020-03-06 20:54:00.104248' # pragma: no cover
@extend_schema_field(InlineSerializer(allow_null=True))
def get_field_j(self, object):
return InlineSerializer({}).data # pragma: no cover
@extend_schema_field(InlineSerializer(many=True))
def get_field_k(self, object):
return InlineSerializer([], many=True).data # pragma: no cover
@extend_schema_field(serializers.ChoiceField(choices=['a', 'b']))
def get_field_l(self, object):
return object.some_choice # pragma: no cover
@extend_schema_field({'type': 'array', 'items': {'type': 'integer'}})
def get_field_m(self, object):
return [1, 2, 3] # pragma: no cover
with mock.patch('rest_framework.settings.api_settings.DEFAULT_SCHEMA_CLASS', AutoSchema):
class DoesItAllViewset(viewsets.GenericViewSet):
serializer_class = AlphaSerializer
@extend_schema(
operation_id='customname_create',
request=AlphaSerializer,
responses={
200: BetaSerializer(many=True),
201: GammaSerializer,
500: ErrorDetailSerializer,
},
parameters=[
OpenApiParameter(
'expiration_date', OpenApiTypes.DATETIME, description='time the object will expire at'
),
OpenApiParameter(
name='test_mode',
type=bool,
location=OpenApiParameter.HEADER,
enum=[True, False],
default=False,
description='creation will be in the sandbox',
),
OpenApiParameter(
name='X-Api-Version',
type=str,
location=OpenApiParameter.HEADER,
response=True,
),
OpenApiParameter(
name='Location',
type=OpenApiTypes.URI,
location=OpenApiParameter.HEADER,
description='URL of the created resource',
response=[201],
),
],
description='this weird endpoint needs some explaining',
summary='short summary',
deprecated=True,
tags=['custom_tag'],
)
def create(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
@extend_schema(exclude=True)
def list(self, request, *args, **kwargs):
return Response([]) # pragma: no cover
@extend_schema(
parameters=[OpenApiParameter('id', OpenApiTypes.INT, OpenApiParameter.PATH)],
request=None,
responses={201: None},
)
@action(detail=True, methods=['POST'])
def subscribe(self, request):
return Response(status=201) # pragma: no cover
@extend_schema(
request=OpenApiTypes.OBJECT,
responses={201: None},
parameters=[OpenApiParameter('ephemeral', OpenApiTypes.UUID, OpenApiParameter.PATH)]
)
@action(detail=False, url_path='callback/(?P<ephemeral>[^/.]+)', methods=['POST'])
def callback(self, request, ephemeral, pk):
return Response(status=201) # pragma: no cover
@extend_schema(responses={204: None})
@action(detail=False, url_path='only-response-override', methods=['POST'])
def only_response_override(self, request):
return Response(status=201) # pragma: no cover
@extend_schema(parameters=[
QuerySerializer, # exploded
OpenApiParameter('nested', QuerySerializer) # nested
])
@action(detail=False, url_path='serializer-query', methods=['GET'])
def serializer_query(self, request):
return Response([]) # pragma: no cover
# this is intended as a measure of last resort when nothing else works
@extend_schema(operation={
"operationId": "manual_endpoint",
"description": "fallback mechanism where can go all out",
"tags": ["manual_tag"],
"requestBody": {
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/Alpha"}
},
}
},
"deprecated": True,
"responses": {
"200": {
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/Gamma"}
}
},
"description": ""
},
}
})
@action(detail=False, methods=['POST'])
def manual(self, request):
return Response() # pragma: no cover
@extend_schema(request=DeltaSerializer)
@action(detail=False, methods=['POST'])
def non_required_body(self, request):
return Response([]) # pragma: no cover
@extend_schema(
request={
'application/json': dict,
'application/pdf': bytes,
'text/html': OpenApiTypes.STR
},
responses=None
)
@action(detail=False, methods=['POST'])
def custom_request_override(self, request):
return Response([]) # pragma: no cover
@extend_schema(responses={
(200, 'application/pdf'): bytes
})
@action(detail=False, methods=['GET'])
def document(self, request):
return Response(b'deadbeef', status=200) # pragma: no cover
def test_extend_schema(no_warnings):
assert_schema(
generate_schema('doesitall', DoesItAllViewset),
'tests/test_extend_schema.yml'
)
@mock.patch('drf_spectacular.settings.spectacular_settings.OAS_VERSION', '3.1.0')
def test_extend_schema_field_with_dict_oas_3_1(no_warnings):
@extend_schema_field({"type": "string"})
class CustomField(serializers.CharField):
pass
class XSerializer(serializers.Serializer):
field1 = CustomField(read_only=True, allow_null=True)
field2 = CustomField(read_only=True, allow_null=True)
field3 = CustomField(read_only=True, allow_null=True)
@extend_schema(request=XSerializer, responses=XSerializer)
@api_view(['POST'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('x', view_function=view_func)
assert schema['components']['schemas']['X']['properties'] == {
'field1': {'readOnly': True, 'type': ['string', 'null']},
'field2': {'readOnly': True, 'type': ['string', 'null']},
'field3': {'readOnly': True, 'type': ['string', 'null']}
}
@mock.patch('drf_spectacular.settings.spectacular_settings.OAS_VERSION', '3.1.0')
def test_extend_schema_field_with_schema_as_oas_3_1(no_warnings):
@extend_schema_field({'type': ['string', 'integer']})
class CustomField(serializers.CharField):
pass
class XSerializer(serializers.Serializer):
field1 = CustomField(read_only=True, allow_null=True)
field2 = CustomField(read_only=True, allow_null=True)
@extend_schema(request=XSerializer, responses=XSerializer)
@api_view(['POST'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('x', view_function=view_func)
assert schema['components']['schemas']['X']['properties'] == {
'field1': {'readOnly': True, 'type': ['string', 'integer', 'null']},
'field2': {'readOnly': True, 'type': ['string', 'integer', 'null']},
}
def test_layered_extend_schema_on_view_and_method_with_meta(no_warnings):
class XSerializer(serializers.Serializer):
field = serializers.IntegerField()
@extend_schema(tags=['view_tag2'])
@extend_schema(tags=['view_tag'], description='view_desc', summary='view_sum')
class XViewset(mixins.ListModelMixin, mixins.CreateModelMixin, viewsets.GenericViewSet):
serializer_class = XSerializer
@extend_schema(tags=['create_tag2'])
@extend_schema(tags=['create_tag'], description='create_desc')
def create(self, request, *args, **kwargs):
super().create(request, *args, **kwargs) # pragma: no cover
@extend_schema(tags=['extended_action_tag2'])
@extend_schema(tags=['extended_action_tag'], description='extended_action_desc')
@action(detail=False, methods=['GET'])
def extended_action(self, request):
return Response() # pragma: no cover
@action(detail=False, methods=['GET'])
def raw_action(self, request):
return Response() # pragma: no cover
schema = generate_schema('x', XViewset)
create_op = schema['paths']['/x/']['post']
list_op = schema['paths']['/x/']['get']
raw_action_op = schema['paths']['/x/raw_action/']['get']
extended_action_op = schema['paths']['/x/extended_action/']['get']
assert create_op['tags'][0] == 'create_tag2'
assert create_op['description'] == 'create_desc'
assert create_op['summary'] == 'view_sum'
assert list_op['tags'][0] == 'view_tag2'
assert list_op['description'] == 'view_desc'
assert list_op['summary'] == 'view_sum'
assert raw_action_op['tags'][0] == 'view_tag2'
assert raw_action_op['description'] == 'view_desc'
assert raw_action_op['summary'] == 'view_sum'
assert extended_action_op['tags'][0] == 'extended_action_tag2'
assert extended_action_op['description'] == 'extended_action_desc'
assert extended_action_op['summary'] == 'view_sum'
def test_layered_extend_schema_on_view_and_method_with_serializer(no_warnings):
class ASerializer(serializers.Serializer):
field = serializers.IntegerField()
class BSerializer(serializers.Serializer):
field = serializers.IntegerField()
class CSerializer(serializers.Serializer):
field = serializers.IntegerField()
@extend_schema(responses=BSerializer)
class XViewset(mixins.ListModelMixin, mixins.CreateModelMixin, viewsets.GenericViewSet):
serializer_class = ASerializer
@extend_schema(responses=CSerializer)
def create(self, request, *args, **kwargs):
super().create(request, *args, **kwargs) # pragma: no cover
@extend_schema(responses=CSerializer)
@action(detail=False, methods=['GET'])
def extended_action(self, request):
return Response() # pragma: no cover
@action(detail=False, methods=['GET'])
def raw_action(self, request):
return Response() # pragma: no cover
schema = generate_schema('x', XViewset)
create_op = get_response_schema(schema['paths']['/x/']['post'])
list_op = get_response_schema(schema['paths']['/x/']['get'])
raw_action_op = get_response_schema(schema['paths']['/x/raw_action/']['get'])
extended_action_op = get_response_schema(schema['paths']['/x/extended_action/']['get'])
assert create_op['$ref'].endswith('C')
assert extended_action_op['$ref'].endswith('C')
assert list_op['items']['$ref'].endswith('B')
assert raw_action_op['$ref'].endswith('B')
def test_extend_schema_field_with_serializer_as_override(no_warnings):
class OverrideSerializer(serializers.Serializer):
field = serializers.UUIDField()
@extend_schema_field(field=OverrideSerializer)
class CustomField(serializers.CharField):
pass
class XSerializer(serializers.Serializer):
field = CustomField(read_only=True)
@extend_schema(request=XSerializer, responses=XSerializer)
@api_view(['POST'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('x', view_function=view_func)
assert schema['components']['schemas']['Override']['type'] == 'object'
property_field = schema['components']['schemas']['X']['properties']['field']
assert 'Override' in property_field['allOf'][0]['$ref']
assert property_field['readOnly']
def test_extend_schema_field_custom_schema_with_without_breakout(no_warnings):
field_schema = {'type': 'string', 'pattern': '^[0-9]*$', 'description': 'some explaining'}
@extend_schema_field(field=field_schema, component_name='Breakout')
class CustomBreakoutField(serializers.CharField):
pass
@extend_schema_field(field=field_schema)
class CustomField(serializers.CharField):
pass
class XSerializer(serializers.Serializer):
field = CustomField(read_only=True)
field_breakout = CustomBreakoutField(read_only=True)
@extend_schema(request=XSerializer, responses=XSerializer)
@api_view(['POST'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('x', view_function=view_func)
assert schema['components']['schemas']['Breakout']['type'] == 'string'
properties = schema['components']['schemas']['X']['properties']
assert properties['field']['description'] == 'some explaining'
assert properties['field']['readOnly']
assert 'Breakout' in properties['field_breakout']['allOf'][0]['$ref']
assert properties['field_breakout']['readOnly']
def test_extend_schema_field_with_field_class(no_warnings) -> None:
class XSerializer(serializers.Serializer):
field = serializers.SerializerMethodField()
@extend_schema_field(serializers.IntegerField())
def get_field(self, object):
return 1 # pragma: no cover
@extend_schema(responses=XSerializer)
@api_view(['GET'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('x', view_function=view_func)
assert schema['components']['schemas']['X'] == {
'type': 'object',
'properties': {'field': {'type': 'integer', 'readOnly': True}},
'required': ['field']
}
|