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
|
# -*- coding: utf-8 -*-
# @Author : llc
# @Time : 2023/8/6 13:47
from enum import Enum
from typing import Union, Any
import pytest
from pydantic import BaseModel
from flask_openapi3 import FileStorage, OpenAPI
app = OpenAPI(__name__)
app.config["TESTING"] = True
@pytest.fixture
def client():
client = app.test_client()
return client
class MetadataParameter(BaseModel):
tag: str
class MetadataParameter2(BaseModel):
tag2: str
class FileType(int, Enum):
a = 1
b = 2
class FormParameters(BaseModel):
file: FileStorage
file_list: list[FileStorage]
file_type: FileType
number: float
number_list: list[float]
boolean: bool
boolean_list: list[bool]
digit: int
digit_list: list[int]
string: str
string_list: list[str]
obj: dict[Any, Any]
parameter: MetadataParameter
parameter_dict: dict[str, MetadataParameter]
parameter_list: list[MetadataParameter]
parameter_list_union: list[Union[bool, float, str, int, FileType, MetadataParameter]]
parameter_union: Union[MetadataParameter, MetadataParameter2]
union_all: Union[str, int, float, bool, FileType, MetadataParameter]
none: None = None
default_value: str = "default_value"
class FormParameter(BaseModel):
obj: dict[Any, Any]
model_config = dict(
openapi_extra={
"encoding": {
"historyMetadata": {
"contentType": "application/xml; charset=utf-8"
},
"profileImage": {
"contentType": "image/png, image/jpeg",
"headers": {
"X-Rate-Limit-Limit": {
"description": "The number of allowed requests in the current period",
"schema": {
"type": "integer"
}
}
}
}
}
}
)
@app.post("/example")
def complex_form_example(form: FormParameters):
print(form.model_dump())
return "ok"
@app.post("/example2")
def invalid_json_in_form_example(form: FormParameter):
print(form.model_dump())
return "ok"
def test_openapi(client):
from io import BytesIO
data = {
"boolean": "true",
"boolean_list": [True, False],
"digit": "1",
"digit_list": ["2", "3"],
"file": (BytesIO(b"post-data"), "filename"),
"file_list": [(BytesIO(b"post-data"), "filename"), (BytesIO(b"post-data"), "filename")],
"file_type": "1",
"none": "null",
"number": "1.2",
"number_list": ["3.4", "5.6"],
"obj": '{"a": 2}',
"parameter": '{"tag": "string"}',
"parameter_dict": '{"additionalProp1": {"tag": "string"}, "additionalProp2": {"tag": "string"},'
'"additionalProp3": {"tag": "string"}}',
"parameter_list": ['{"tag": "string"}', '{"tag": "string"}'],
"parameter_list_union": ["ok", '{"tag": "string"}', "7.8"],
"parameter_union": '{"tag2": "string"}',
"union_all": "true",
"string": "a",
"string_list": ["a", "b", "c"]
}
resp = client.post("/example", data=data, content_type="multipart/form-data")
print(resp.text)
assert resp.status_code == 200
def test_invalid_json_in_form_example(client):
data = {
"obj": "{a: 2}"
}
resp = client.post("/example2", data=data, content_type="multipart/form-data")
assert resp.status_code == 422
data = {
"obj": '{"a": 2}'
}
resp = client.post("/example2", data=data, content_type="multipart/form-data")
assert resp.status_code == 200
|
