forked from tiangolo/fastapi
/
test_response_model_as_return_annotation.py
141 lines (120 loc) · 3.91 KB
/
test_response_model_as_return_annotation.py
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
from fastapi import FastAPI
from fastapi.testclient import TestClient
from pydantic import BaseModel
class ModelOne(BaseModel):
name: str
class ModelTwo(BaseModel):
surname: str
app = FastAPI()
@app.get("/valid1")
def valid1() -> ModelOne:
return ModelOne(name="Test")
@app.get("/valid2", response_model=ModelTwo)
def valid2():
return ModelTwo(surname="Test")
@app.get("/valid3", response_model=ModelTwo)
def valid3() -> ModelOne:
return ModelTwo(surname="Test")
@app.get("/valid4")
def valid4() -> "ModelOne":
return ModelOne(name="Test")
openapi_schema = {
"openapi": "3.0.2",
"info": {"title": "FastAPI", "version": "0.1.0"},
"paths": {
"/valid1": {
"get": {
"summary": "Valid1",
"operationId": "valid1_valid1_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/ModelOne"}
}
},
}
},
}
},
"/valid2": {
"get": {
"summary": "Valid2",
"operationId": "valid2_valid2_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/ModelTwo"}
}
},
}
},
}
},
"/valid3": {
"get": {
"summary": "Valid3",
"operationId": "valid3_valid3_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/ModelTwo"}
}
},
}
},
}
},
"/valid4": {
"get": {
"summary": "Valid4",
"operationId": "valid4_valid4_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/ModelOne"}
}
},
}
},
}
},
},
"components": {
"schemas": {
"ModelOne": {
"title": "ModelOne",
"required": ["name"],
"type": "object",
"properties": {"name": {"title": "Name", "type": "string"}},
},
"ModelTwo": {
"title": "ModelTwo",
"required": ["surname"],
"type": "object",
"properties": {"surname": {"title": "Surname", "type": "string"}},
},
}
},
}
client = TestClient(app)
def test_openapi_schema():
response = client.get("/openapi.json")
assert response.status_code == 200, response.text
assert response.json() == openapi_schema
def test_path_operations():
response = client.get("/valid1")
assert response.status_code == 200, response.text
response = client.get("/valid2")
assert response.status_code == 200, response.text
response = client.get("/valid3")
assert response.status_code == 200, response.text
response = client.get("/valid4")
assert response.status_code == 200, response.text