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
|
from typing import TYPE_CHECKING, Any, List, Type
import pytest
from litestar import Litestar, get
from litestar.exceptions import ImproperlyConfiguredException
from litestar.openapi.config import OpenAPIConfig
from litestar.openapi.controller import OpenAPIController
from litestar.openapi.plugins import RedocRenderPlugin, SwaggerRenderPlugin
from litestar.openapi.spec import Components, Example, OpenAPIHeader, OpenAPIType, Schema
if TYPE_CHECKING:
from litestar.handlers.http_handlers import HTTPRouteHandler
from litestar.openapi.plugins import OpenAPIRenderPlugin
def test_merged_components_correct() -> None:
components_one = Components(headers={"one": OpenAPIHeader()}, schemas={"test": Schema(type=OpenAPIType.STRING)})
components_two = Components(headers={"two": OpenAPIHeader()})
components_three = Components(examples={"example-one": Example(summary="an example")})
config = OpenAPIConfig(
title="my title", version="1.0.0", components=[components_one, components_two, components_three]
)
openapi = config.to_openapi_schema()
assert openapi.components
assert openapi.components.to_schema() == {
"schemas": {"test": {"type": "string"}},
"examples": {"example-one": {"summary": "an example"}},
"headers": {
"one": {
"required": False,
"deprecated": False,
},
"two": {
"required": False,
"deprecated": False,
},
},
}
def test_allows_customization_of_operation_id_creator() -> None:
def operation_id_creator(handler: "HTTPRouteHandler", _: Any, __: Any) -> str:
return handler.name or ""
@get(path="/1", name="x")
def handler_1() -> None:
return
@get(path="/2", name="y")
def handler_2() -> None:
return
app = Litestar(
route_handlers=[handler_1, handler_2],
openapi_config=OpenAPIConfig(title="my title", version="1.0.0", operation_id_creator=operation_id_creator),
)
assert app.openapi_schema.to_schema()["paths"] == {
"/1": {
"get": {
"deprecated": False,
"operationId": "x",
"responses": {"200": {"description": "Request fulfilled, document follows", "headers": {}}},
"summary": "Handler1",
}
},
"/2": {
"get": {
"deprecated": False,
"operationId": "y",
"responses": {"200": {"description": "Request fulfilled, document follows", "headers": {}}},
"summary": "Handler2",
}
},
}
def test_allows_customization_of_path() -> None:
app = Litestar(
openapi_config=OpenAPIConfig(
title="my title", version="1.0.0", openapi_controller=OpenAPIController, path="/custom_schema_path"
),
)
assert app.openapi_config
assert app.openapi_config.path == "/custom_schema_path"
assert app.openapi_config.openapi_controller is not None
assert app.openapi_config.openapi_controller.path == "/custom_schema_path"
def test_raises_exception_when_no_config_in_place() -> None:
with pytest.raises(ImproperlyConfiguredException):
Litestar(route_handlers=[], openapi_config=None).update_openapi_schema()
@pytest.mark.parametrize(
("plugins", "exp"),
[
((), RedocRenderPlugin),
([RedocRenderPlugin()], RedocRenderPlugin),
([SwaggerRenderPlugin(), RedocRenderPlugin()], SwaggerRenderPlugin),
([RedocRenderPlugin(), SwaggerRenderPlugin(path="/")], SwaggerRenderPlugin),
],
)
def test_default_plugin(plugins: "List[OpenAPIRenderPlugin]", exp: "Type[OpenAPIRenderPlugin]") -> None:
config = OpenAPIConfig(title="my title", version="1.0.0", render_plugins=plugins)
assert isinstance(config.default_plugin, exp)
def test_default_plugin_legacy() -> None:
config = OpenAPIConfig(title="my title", version="1.0.0", openapi_controller=OpenAPIController)
assert config.default_plugin is None
|
