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
|
from unittest import mock
import pytest
import yaml
from django import __version__ as DJANGO_VERSION
from django.http import HttpResponseRedirect
from django.urls import path
from rest_framework.decorators import api_view
from rest_framework.response import Response
from rest_framework.test import APIClient
from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import extend_schema
from drf_spectacular.validation import validate_schema
from drf_spectacular.views import (
SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerOauthRedirectView,
SpectacularSwaggerSplitView, SpectacularSwaggerView,
)
@extend_schema(responses=OpenApiTypes.FLOAT)
@api_view(http_method_names=['GET'])
def pi(request):
return Response(3.1415)
urlpatterns_v1 = [path('api/v1/pi/', pi)]
urlpatterns_v1.append(
path('api/v1/schema/', SpectacularAPIView.as_view(urlconf=urlpatterns_v1))
)
urlpatterns_v2 = [
path('api/v2/pi/', pi),
path('api/v2/pi-fast/', pi),
path('api/v2/schema/swagger-ui/', SpectacularSwaggerView.as_view(), name='swagger'),
path(
"api/v1/schema/swagger-ui/oauth2-redirect.html",
SpectacularSwaggerOauthRedirectView.as_view(),
name="swagger-oauth-redirect"),
path('api/v2/schema/swagger-ui-alt/', SpectacularSwaggerSplitView.as_view(), name='swagger-alt'),
path('api/v2/schema/redoc/', SpectacularRedocView.as_view(), name='redoc'),
]
urlpatterns_v2.append(
path('api/v2/schema/', SpectacularAPIView.as_view(urlconf=urlpatterns_v2), name='schema'),
)
urlpatterns_str_import = [
path('api/schema-str1/', SpectacularAPIView.as_view(urlconf=['tests.test_view']), name='schema_str1'),
path('api/schema-str2/', SpectacularAPIView.as_view(urlconf='tests.test_view'), name='schema_str2'),
path('api/schema-err1/', SpectacularAPIView.as_view(urlconf=['tests.error']), name='schema_err1'),
path('api/schema-err2/', SpectacularAPIView.as_view(urlconf='tests.error'), name='schema_err2'),
]
urlpatterns = urlpatterns_v1 + urlpatterns_v2 + urlpatterns_str_import
@pytest.mark.urls(__name__)
def test_spectacular_view(no_warnings):
response = APIClient().get('/api/v1/schema/')
assert response.status_code == 200
assert response.content.startswith(b'openapi: 3.0.3\n')
assert response.accepted_media_type == 'application/vnd.oai.openapi'
if DJANGO_VERSION > '3':
assert response.headers.get('CONTENT-DISPOSITION') == 'inline; filename="schema.yaml"'
schema = yaml.load(response.content, Loader=yaml.SafeLoader)
validate_schema(schema)
assert len(schema['paths']) == 2
@pytest.mark.urls(__name__)
def test_spectacular_view_custom_urlconf(no_warnings):
response = APIClient().get('/api/v2/schema/')
assert response.status_code == 200
schema = yaml.load(response.content, Loader=yaml.SafeLoader)
validate_schema(schema)
assert len(schema['paths']) == 3
response = APIClient().get('/api/v2/pi-fast/')
assert response.status_code == 200
assert response.content == b'3.1415'
@pytest.mark.parametrize(['accept', 'format', 'indent'], [
('application/vnd.oai.openapi', 'yaml', None),
('application/yaml', 'yaml', None),
('application/vnd.oai.openapi+json', 'json', 4),
('application/json', 'json', 4),
('application/json; indent=8', 'json', 8),
])
@pytest.mark.urls(__name__)
def test_spectacular_view_accept(accept, format, indent):
response = APIClient().get('/api/v1/schema/', HTTP_ACCEPT=accept)
assert response.status_code == 200
assert response.accepted_media_type == accept
if format == 'json':
assert response.content.startswith(b'{\n' + indent * b' ' + b'"openapi": "3.0.3"')
if format == 'yaml':
assert response.content.startswith(b'openapi: 3.0.3\n')
@pytest.mark.urls(__name__)
def test_spectacular_view_accept_unknown(no_warnings):
response = APIClient().get('/api/v1/schema/', HTTP_ACCEPT='application/unknown')
assert response.status_code == 406
assert response.content == (
b'detail:\n string: Could not satisfy the request Accept header.\n'
b' code: not_acceptable\n'
)
@pytest.mark.parametrize('ui', ['redoc', 'swagger-ui'])
@pytest.mark.urls(__name__)
def test_spectacular_ui_view(no_warnings, ui):
from drf_spectacular.settings import spectacular_settings
response = APIClient().get(f'/api/v2/schema/{ui}/')
assert response.status_code == 200
assert response.content.startswith(b'<!DOCTYPE html>')
if ui == 'redoc':
assert b'<title>Redoc</title>' in response.content
assert spectacular_settings.REDOC_DIST.encode() in response.content
else:
assert b'<title>Swagger</title>' in response.content
assert spectacular_settings.SWAGGER_UI_DIST.encode() in response.content
assert b'"/api/v2/schema/"' in response.content
@pytest.mark.urls(__name__)
def test_spectacular_swagger_ui_alternate(no_warnings):
# first request for the html
response = APIClient().get('/api/v2/schema/swagger-ui-alt/')
assert response.status_code == 200
assert response.content.startswith(b'<!DOCTYPE html>')
assert b'"/api/v2/schema/swagger-ui-alt/?script="' in response.content
# second request to obtain js swagger config (CSP self)
response = APIClient().get('/api/v2/schema/swagger-ui-alt/?script=')
assert response.status_code == 200
assert b'"/api/v2/schema/"' in response.content
@mock.patch(
'drf_spectacular.settings.spectacular_settings.SWAGGER_UI_SETTINGS',
'{"deepLinking": true}'
)
@pytest.mark.urls(__name__)
def test_spectacular_ui_with_raw_settings(no_warnings):
response = APIClient().get('/api/v2/schema/swagger-ui/')
assert response.status_code == 200
assert b'const swaggerSettings = {"deepLinking": true};\n' in response.content
@pytest.mark.urls(__name__)
def test_spectacular_ui_coop():
response = APIClient().get('/api/v2/schema/swagger-ui/')
assert response.status_code == 200
assert response["Cross-Origin-Opener-Policy"] == "unsafe-none"
@pytest.mark.urls(__name__)
def test_spectacular_ui_param_passthrough(no_warnings):
response = APIClient().get('/api/v2/schema/swagger-ui/?foo=bar&lang=jp&version=v2')
assert response.status_code == 200
assert b'url: "/api/v2/schema/?lang\\u003Djp\\u0026version\\u003Dv2"' in response.content
@pytest.mark.parametrize('url', ['/api/schema-str1/', '/api/schema-str2/'])
@pytest.mark.urls(__name__)
def test_spectacular_urlconf_module_list_import(no_warnings, url):
response = APIClient().get(url)
assert response.status_code == 200
assert b'/api/v1/pi/' in response.content
assert b'/api/v2/pi/' in response.content
@pytest.mark.parametrize('url', ['/api/schema-err1/', '/api/schema-err2/'])
@pytest.mark.urls(__name__)
def test_spectacular_urlconf_module_list_import_error(no_warnings, url):
with pytest.raises(ModuleNotFoundError):
APIClient().get(url)
@pytest.mark.parametrize('get_params', ['', 'code=foobar123&state=xyz&session_state=hello-world'])
@pytest.mark.urls(__name__)
def test_swagger_oauth_redirect_view(get_params):
# act
response = APIClient().get('/api/v1/schema/swagger-ui/oauth2-redirect.html?' + get_params)
# assert
assert response.status_code == 302
if isinstance(response, HttpResponseRedirect):
# older django versions test client directly returns the response instance
assert response.url == '/static/drf_spectacular_sidecar/swagger-ui-dist/oauth2-redirect.html?' + get_params
else:
assert response.headers['Location'] ==\
'/static/drf_spectacular_sidecar/swagger-ui-dist/oauth2-redirect.html?' + get_params
|
