Coverage for tests/test_response_model_as_return_annotation.py: 100%

1from typing import List, Union 5 ctx1abcde

2 

3import pytest 5 ctx1abcde

4from fastapi import FastAPI 5 ctx1abcde

5from fastapi.exceptions import FastAPIError, ResponseValidationError 5 ctx1abcde

6from fastapi.responses import JSONResponse, Response 5 ctx1abcde

7from fastapi.testclient import TestClient 5 ctx1abcde

8from pydantic import BaseModel 5 ctx1abcde

9 

10 

11class BaseUser(BaseModel): 5 ctx1abcde

12 name: str 5 ctx1abcde

13 

14 

15class User(BaseUser): 5 ctx1abcde

16 surname: str 5 ctx1abcde

17 

18 

19class DBUser(User): 5 ctx1abcde

20 password_hash: str 5 ctx1abcde

21 

22 

23class Item(BaseModel): 5 ctx1abcde

24 name: str 5 ctx1abcde

25 price: float 5 ctx1abcde

26 

27 

28app = FastAPI() 5 ctx1abcde

29 

30 

31@app.get("/no_response_model-no_annotation-return_model") 5 ctx1abcde

32def no_response_model_no_annotation_return_model(): 5 ctx1abcde

33 return User(name="John", surname="Doe") 5 ctx1abcde

34 

35 

36@app.get("/no_response_model-no_annotation-return_dict") 5 ctx1abcde

37def no_response_model_no_annotation_return_dict(): 5 ctx1abcde

38 return {"name": "John", "surname": "Doe"} 5 ctx1abcde

39 

40 

41@app.get("/response_model-no_annotation-return_same_model", response_model=User) 5 ctx1abcde

42def response_model_no_annotation_return_same_model(): 5 ctx1abcde

43 return User(name="John", surname="Doe") 5 ctx1abcde

44 

45 

46@app.get("/response_model-no_annotation-return_exact_dict", response_model=User) 5 ctx1abcde

47def response_model_no_annotation_return_exact_dict(): 5 ctx1abcde

48 return {"name": "John", "surname": "Doe"} 5 ctx1abcde

49 

50 

51@app.get("/response_model-no_annotation-return_invalid_dict", response_model=User) 5 ctx1abcde

52def response_model_no_annotation_return_invalid_dict(): 5 ctx1abcde

53 return {"name": "John"} 5 ctx1abcde

54 

55 

56@app.get("/response_model-no_annotation-return_invalid_model", response_model=User) 5 ctx1abcde

57def response_model_no_annotation_return_invalid_model(): 5 ctx1abcde

58 return Item(name="Foo", price=42.0) 5 ctx1abcde

59 

60 

61@app.get( 5 ctx1abcde

62 "/response_model-no_annotation-return_dict_with_extra_data", response_model=User 

63) 

64def response_model_no_annotation_return_dict_with_extra_data(): 5 ctx1abcde

65 return {"name": "John", "surname": "Doe", "password_hash": "secret"} 5 ctx1abcde

66 

67 

68@app.get( 5 ctx1abcde

69 "/response_model-no_annotation-return_submodel_with_extra_data", response_model=User 

70) 

71def response_model_no_annotation_return_submodel_with_extra_data(): 5 ctx1abcde

72 return DBUser(name="John", surname="Doe", password_hash="secret") 5 ctx1abcde

73 

74 

75@app.get("/no_response_model-annotation-return_same_model") 5 ctx1abcde

76def no_response_model_annotation_return_same_model() -> User: 5 ctx1abcde

77 return User(name="John", surname="Doe") 5 ctx1abcde

78 

79 

80@app.get("/no_response_model-annotation-return_exact_dict") 5 ctx1abcde

81def no_response_model_annotation_return_exact_dict() -> User: 5 ctx1abcde

82 return {"name": "John", "surname": "Doe"} 5 ctx1abcde

83 

84 

85@app.get("/no_response_model-annotation-return_invalid_dict") 5 ctx1abcde

86def no_response_model_annotation_return_invalid_dict() -> User: 5 ctx1abcde

87 return {"name": "John"} 5 ctx1abcde

88 

89 

90@app.get("/no_response_model-annotation-return_invalid_model") 5 ctx1abcde

91def no_response_model_annotation_return_invalid_model() -> User: 5 ctx1abcde

92 return Item(name="Foo", price=42.0) 5 ctx1abcde

93 

94 

95@app.get("/no_response_model-annotation-return_dict_with_extra_data") 5 ctx1abcde

96def no_response_model_annotation_return_dict_with_extra_data() -> User: 5 ctx1abcde

97 return {"name": "John", "surname": "Doe", "password_hash": "secret"} 5 ctx1abcde

98 

99 

100@app.get("/no_response_model-annotation-return_submodel_with_extra_data") 5 ctx1abcde

101def no_response_model_annotation_return_submodel_with_extra_data() -> User: 5 ctx1abcde

102 return DBUser(name="John", surname="Doe", password_hash="secret") 5 ctx1abcde

103 

104 

105@app.get("/response_model_none-annotation-return_same_model", response_model=None) 5 ctx1abcde

106def response_model_none_annotation_return_same_model() -> User: 5 ctx1abcde

107 return User(name="John", surname="Doe") 5 ctx1abcde

108 

109 

110@app.get("/response_model_none-annotation-return_exact_dict", response_model=None) 5 ctx1abcde

111def response_model_none_annotation_return_exact_dict() -> User: 5 ctx1abcde

112 return {"name": "John", "surname": "Doe"} 5 ctx1abcde

113 

114 

115@app.get("/response_model_none-annotation-return_invalid_dict", response_model=None) 5 ctx1abcde

116def response_model_none_annotation_return_invalid_dict() -> User: 5 ctx1abcde

117 return {"name": "John"} 5 ctx1abcde

118 

119 

120@app.get("/response_model_none-annotation-return_invalid_model", response_model=None) 5 ctx1abcde

121def response_model_none_annotation_return_invalid_model() -> User: 5 ctx1abcde

122 return Item(name="Foo", price=42.0) 5 ctx1abcde

123 

124 

125@app.get( 5 ctx1abcde

126 "/response_model_none-annotation-return_dict_with_extra_data", response_model=None 

127) 

128def response_model_none_annotation_return_dict_with_extra_data() -> User: 5 ctx1abcde

129 return {"name": "John", "surname": "Doe", "password_hash": "secret"} 5 ctx1abcde

130 

131 

132@app.get( 5 ctx1abcde

133 "/response_model_none-annotation-return_submodel_with_extra_data", 

134 response_model=None, 

135) 

136def response_model_none_annotation_return_submodel_with_extra_data() -> User: 5 ctx1abcde

137 return DBUser(name="John", surname="Doe", password_hash="secret") 5 ctx1abcde

138 

139 

140@app.get( 5 ctx1abcde

141 "/response_model_model1-annotation_model2-return_same_model", response_model=User 

142) 

143def response_model_model1_annotation_model2_return_same_model() -> Item: 5 ctx1abcde

144 return User(name="John", surname="Doe") 5 ctx1abcde

145 

146 

147@app.get( 5 ctx1abcde

148 "/response_model_model1-annotation_model2-return_exact_dict", response_model=User 

149) 

150def response_model_model1_annotation_model2_return_exact_dict() -> Item: 5 ctx1abcde

151 return {"name": "John", "surname": "Doe"} 5 ctx1abcde

152 

153 

154@app.get( 5 ctx1abcde

155 "/response_model_model1-annotation_model2-return_invalid_dict", response_model=User 

156) 

157def response_model_model1_annotation_model2_return_invalid_dict() -> Item: 5 ctx1abcde

158 return {"name": "John"} 5 ctx1abcde

159 

160 

161@app.get( 5 ctx1abcde

162 "/response_model_model1-annotation_model2-return_invalid_model", response_model=User 

163) 

164def response_model_model1_annotation_model2_return_invalid_model() -> Item: 5 ctx1abcde

165 return Item(name="Foo", price=42.0) 5 ctx1abcde

166 

167 

168@app.get( 5 ctx1abcde

169 "/response_model_model1-annotation_model2-return_dict_with_extra_data", 

170 response_model=User, 

171) 

172def response_model_model1_annotation_model2_return_dict_with_extra_data() -> Item: 5 ctx1abcde

173 return {"name": "John", "surname": "Doe", "password_hash": "secret"} 5 ctx1abcde

174 

175 

176@app.get( 5 ctx1abcde

177 "/response_model_model1-annotation_model2-return_submodel_with_extra_data", 

178 response_model=User, 

179) 

180def response_model_model1_annotation_model2_return_submodel_with_extra_data() -> Item: 5 ctx1abcde

181 return DBUser(name="John", surname="Doe", password_hash="secret") 5 ctx1abcde

182 

183 

184@app.get( 5 ctx1abcde

185 "/response_model_filtering_model-annotation_submodel-return_submodel", 

186 response_model=User, 

187) 

188def response_model_filtering_model_annotation_submodel_return_submodel() -> DBUser: 5 ctx1abcde

189 return DBUser(name="John", surname="Doe", password_hash="secret") 5 ctx1abcde

190 

191 

192@app.get("/response_model_list_of_model-no_annotation", response_model=List[User]) 5 ctx1abcde

193def response_model_list_of_model_no_annotation(): 5 ctx1abcde

194 return [ 5 ctx1abcde

195 DBUser(name="John", surname="Doe", password_hash="secret"), 

196 DBUser(name="Jane", surname="Does", password_hash="secret2"), 

197 ] 

198 

199 

200@app.get("/no_response_model-annotation_list_of_model") 5 ctx1abcde

201def no_response_model_annotation_list_of_model() -> List[User]: 5 ctx1abcde

202 return [ 5 ctx1abcde

203 DBUser(name="John", surname="Doe", password_hash="secret"), 

204 DBUser(name="Jane", surname="Does", password_hash="secret2"), 

205 ] 

206 

207 

208@app.get("/no_response_model-annotation_forward_ref_list_of_model") 5 ctx1abcde

209def no_response_model_annotation_forward_ref_list_of_model() -> "List[User]": 5 ctx1abcde

210 return [ 5 ctx1abcde

211 DBUser(name="John", surname="Doe", password_hash="secret"), 

212 DBUser(name="Jane", surname="Does", password_hash="secret2"), 

213 ] 

214 

215 

216@app.get( 5 ctx1abcde

217 "/response_model_union-no_annotation-return_model1", 

218 response_model=Union[User, Item], 

219) 

220def response_model_union_no_annotation_return_model1(): 5 ctx1abcde

221 return DBUser(name="John", surname="Doe", password_hash="secret") 5 ctx1abcde

222 

223 

224@app.get( 5 ctx1abcde

225 "/response_model_union-no_annotation-return_model2", 

226 response_model=Union[User, Item], 

227) 

228def response_model_union_no_annotation_return_model2(): 5 ctx1abcde

229 return Item(name="Foo", price=42.0) 5 ctx1abcde

230 

231 

232@app.get("/no_response_model-annotation_union-return_model1") 5 ctx1abcde

233def no_response_model_annotation_union_return_model1() -> Union[User, Item]: 5 ctx1abcde

234 return DBUser(name="John", surname="Doe", password_hash="secret") 5 ctx1abcde

235 

236 

237@app.get("/no_response_model-annotation_union-return_model2") 5 ctx1abcde

238def no_response_model_annotation_union_return_model2() -> Union[User, Item]: 5 ctx1abcde

239 return Item(name="Foo", price=42.0) 5 ctx1abcde

240 

241 

242@app.get("/no_response_model-annotation_response_class") 5 ctx1abcde

243def no_response_model_annotation_response_class() -> Response: 5 ctx1abcde

244 return Response(content="Foo") 5 ctx1abcde

245 

246 

247@app.get("/no_response_model-annotation_json_response_class") 5 ctx1abcde

248def no_response_model_annotation_json_response_class() -> JSONResponse: 5 ctx1abcde

249 return JSONResponse(content={"foo": "bar"}) 5 ctx1abcde

250 

251 

252client = TestClient(app) 5 ctx1abcde

253 

254 

255def test_no_response_model_no_annotation_return_model(): 5 ctx1abcde

256 response = client.get("/no_response_model-no_annotation-return_model") 5 ctx1abcde

257 assert response.status_code == 200, response.text 5 ctx1abcde

258 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

259 

260 

261def test_no_response_model_no_annotation_return_dict(): 5 ctx1abcde

262 response = client.get("/no_response_model-no_annotation-return_dict") 5 ctx1abcde

263 assert response.status_code == 200, response.text 5 ctx1abcde

264 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

265 

266 

267def test_response_model_no_annotation_return_same_model(): 5 ctx1abcde

268 response = client.get("/response_model-no_annotation-return_same_model") 5 ctx1abcde

269 assert response.status_code == 200, response.text 5 ctx1abcde

270 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

271 

272 

273def test_response_model_no_annotation_return_exact_dict(): 5 ctx1abcde

274 response = client.get("/response_model-no_annotation-return_exact_dict") 5 ctx1abcde

275 assert response.status_code == 200, response.text 5 ctx1abcde

276 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

277 

278 

279def test_response_model_no_annotation_return_invalid_dict(): 5 ctx1abcde

280 with pytest.raises(ResponseValidationError) as excinfo: 5 ctx1abcde

281 client.get("/response_model-no_annotation-return_invalid_dict") 5 ctx1abcde

282 assert "missing" in str(excinfo.value) 5 ctx1abcde

283 

284 

285def test_response_model_no_annotation_return_invalid_model(): 5 ctx1abcde

286 with pytest.raises(ResponseValidationError) as excinfo: 5 ctx1abcde

287 client.get("/response_model-no_annotation-return_invalid_model") 5 ctx1abcde

288 assert "missing" in str(excinfo.value) 5 ctx1abcde

289 

290 

291def test_response_model_no_annotation_return_dict_with_extra_data(): 5 ctx1abcde

292 response = client.get("/response_model-no_annotation-return_dict_with_extra_data") 5 ctx1abcde

293 assert response.status_code == 200, response.text 5 ctx1abcde

294 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

295 

296 

297def test_response_model_no_annotation_return_submodel_with_extra_data(): 5 ctx1abcde

298 response = client.get( 5 ctx1abcde

299 "/response_model-no_annotation-return_submodel_with_extra_data" 

300 ) 

301 assert response.status_code == 200, response.text 5 ctx1abcde

302 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

303 

304 

305def test_no_response_model_annotation_return_same_model(): 5 ctx1abcde

306 response = client.get("/no_response_model-annotation-return_same_model") 5 ctx1abcde

307 assert response.status_code == 200, response.text 5 ctx1abcde

308 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

309 

310 

311def test_no_response_model_annotation_return_exact_dict(): 5 ctx1abcde

312 response = client.get("/no_response_model-annotation-return_exact_dict") 5 ctx1abcde

313 assert response.status_code == 200, response.text 5 ctx1abcde

314 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

315 

316 

317def test_no_response_model_annotation_return_invalid_dict(): 5 ctx1abcde

318 with pytest.raises(ResponseValidationError) as excinfo: 5 ctx1abcde

319 client.get("/no_response_model-annotation-return_invalid_dict") 5 ctx1abcde

320 assert "missing" in str(excinfo.value) 5 ctx1abcde

321 

322 

323def test_no_response_model_annotation_return_invalid_model(): 5 ctx1abcde

324 with pytest.raises(ResponseValidationError) as excinfo: 5 ctx1abcde

325 client.get("/no_response_model-annotation-return_invalid_model") 5 ctx1abcde

326 assert "missing" in str(excinfo.value) 5 ctx1abcde

327 

328 

329def test_no_response_model_annotation_return_dict_with_extra_data(): 5 ctx1abcde

330 response = client.get("/no_response_model-annotation-return_dict_with_extra_data") 5 ctx1abcde

331 assert response.status_code == 200, response.text 5 ctx1abcde

332 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

333 

334 

335def test_no_response_model_annotation_return_submodel_with_extra_data(): 5 ctx1abcde

336 response = client.get( 5 ctx1abcde

337 "/no_response_model-annotation-return_submodel_with_extra_data" 

338 ) 

339 assert response.status_code == 200, response.text 5 ctx1abcde

340 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

341 

342 

343def test_response_model_none_annotation_return_same_model(): 5 ctx1abcde

344 response = client.get("/response_model_none-annotation-return_same_model") 5 ctx1abcde

345 assert response.status_code == 200, response.text 5 ctx1abcde

346 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

347 

348 

349def test_response_model_none_annotation_return_exact_dict(): 5 ctx1abcde

350 response = client.get("/response_model_none-annotation-return_exact_dict") 5 ctx1abcde

351 assert response.status_code == 200, response.text 5 ctx1abcde

352 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

353 

354 

355def test_response_model_none_annotation_return_invalid_dict(): 5 ctx1abcde

356 response = client.get("/response_model_none-annotation-return_invalid_dict") 5 ctx1abcde

357 assert response.status_code == 200, response.text 5 ctx1abcde

358 assert response.json() == {"name": "John"} 5 ctx1abcde

359 

360 

361def test_response_model_none_annotation_return_invalid_model(): 5 ctx1abcde

362 response = client.get("/response_model_none-annotation-return_invalid_model") 5 ctx1abcde

363 assert response.status_code == 200, response.text 5 ctx1abcde

364 assert response.json() == {"name": "Foo", "price": 42.0} 5 ctx1abcde

365 

366 

367def test_response_model_none_annotation_return_dict_with_extra_data(): 5 ctx1abcde

368 response = client.get("/response_model_none-annotation-return_dict_with_extra_data") 5 ctx1abcde

369 assert response.status_code == 200, response.text 5 ctx1abcde

370 assert response.json() == { 5 ctx1abcde

371 "name": "John", 

372 "surname": "Doe", 

373 "password_hash": "secret", 

374 } 

375 

376 

377def test_response_model_none_annotation_return_submodel_with_extra_data(): 5 ctx1abcde

378 response = client.get( 5 ctx1abcde

379 "/response_model_none-annotation-return_submodel_with_extra_data" 

380 ) 

381 assert response.status_code == 200, response.text 5 ctx1abcde

382 assert response.json() == { 5 ctx1abcde

383 "name": "John", 

384 "surname": "Doe", 

385 "password_hash": "secret", 

386 } 

387 

388 

389def test_response_model_model1_annotation_model2_return_same_model(): 5 ctx1abcde

390 response = client.get("/response_model_model1-annotation_model2-return_same_model") 5 ctx1abcde

391 assert response.status_code == 200, response.text 5 ctx1abcde

392 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

393 

394 

395def test_response_model_model1_annotation_model2_return_exact_dict(): 5 ctx1abcde

396 response = client.get("/response_model_model1-annotation_model2-return_exact_dict") 5 ctx1abcde

397 assert response.status_code == 200, response.text 5 ctx1abcde

398 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

399 

400 

401def test_response_model_model1_annotation_model2_return_invalid_dict(): 5 ctx1abcde

402 with pytest.raises(ResponseValidationError) as excinfo: 5 ctx1abcde

403 client.get("/response_model_model1-annotation_model2-return_invalid_dict") 5 ctx1abcde

404 assert "missing" in str(excinfo.value) 5 ctx1abcde

405 

406 

407def test_response_model_model1_annotation_model2_return_invalid_model(): 5 ctx1abcde

408 with pytest.raises(ResponseValidationError) as excinfo: 5 ctx1abcde

409 client.get("/response_model_model1-annotation_model2-return_invalid_model") 5 ctx1abcde

410 assert "missing" in str(excinfo.value) 5 ctx1abcde

411 

412 

413def test_response_model_model1_annotation_model2_return_dict_with_extra_data(): 5 ctx1abcde

414 response = client.get( 5 ctx1abcde

415 "/response_model_model1-annotation_model2-return_dict_with_extra_data" 

416 ) 

417 assert response.status_code == 200, response.text 5 ctx1abcde

418 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

419 

420 

421def test_response_model_model1_annotation_model2_return_submodel_with_extra_data(): 5 ctx1abcde

422 response = client.get( 5 ctx1abcde

423 "/response_model_model1-annotation_model2-return_submodel_with_extra_data" 

424 ) 

425 assert response.status_code == 200, response.text 5 ctx1abcde

426 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

427 

428 

429def test_response_model_filtering_model_annotation_submodel_return_submodel(): 5 ctx1abcde

430 response = client.get( 5 ctx1abcde

431 "/response_model_filtering_model-annotation_submodel-return_submodel" 

432 ) 

433 assert response.status_code == 200, response.text 5 ctx1abcde

434 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

435 

436 

437def test_response_model_list_of_model_no_annotation(): 5 ctx1abcde

438 response = client.get("/response_model_list_of_model-no_annotation") 5 ctx1abcde

439 assert response.status_code == 200, response.text 5 ctx1abcde

440 assert response.json() == [ 5 ctx1abcde

441 {"name": "John", "surname": "Doe"}, 

442 {"name": "Jane", "surname": "Does"}, 

443 ] 

444 

445 

446def test_no_response_model_annotation_list_of_model(): 5 ctx1abcde

447 response = client.get("/no_response_model-annotation_list_of_model") 5 ctx1abcde

448 assert response.status_code == 200, response.text 5 ctx1abcde

449 assert response.json() == [ 5 ctx1abcde

450 {"name": "John", "surname": "Doe"}, 

451 {"name": "Jane", "surname": "Does"}, 

452 ] 

453 

454 

455def test_no_response_model_annotation_forward_ref_list_of_model(): 5 ctx1abcde

456 response = client.get("/no_response_model-annotation_forward_ref_list_of_model") 5 ctx1abcde

457 assert response.status_code == 200, response.text 5 ctx1abcde

458 assert response.json() == [ 5 ctx1abcde

459 {"name": "John", "surname": "Doe"}, 

460 {"name": "Jane", "surname": "Does"}, 

461 ] 

462 

463 

464def test_response_model_union_no_annotation_return_model1(): 5 ctx1abcde

465 response = client.get("/response_model_union-no_annotation-return_model1") 5 ctx1abcde

466 assert response.status_code == 200, response.text 5 ctx1abcde

467 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

468 

469 

470def test_response_model_union_no_annotation_return_model2(): 5 ctx1abcde

471 response = client.get("/response_model_union-no_annotation-return_model2") 5 ctx1abcde

472 assert response.status_code == 200, response.text 5 ctx1abcde

473 assert response.json() == {"name": "Foo", "price": 42.0} 5 ctx1abcde

474 

475 

476def test_no_response_model_annotation_union_return_model1(): 5 ctx1abcde

477 response = client.get("/no_response_model-annotation_union-return_model1") 5 ctx1abcde

478 assert response.status_code == 200, response.text 5 ctx1abcde

479 assert response.json() == {"name": "John", "surname": "Doe"} 5 ctx1abcde

480 

481 

482def test_no_response_model_annotation_union_return_model2(): 5 ctx1abcde

483 response = client.get("/no_response_model-annotation_union-return_model2") 5 ctx1abcde

484 assert response.status_code == 200, response.text 5 ctx1abcde

485 assert response.json() == {"name": "Foo", "price": 42.0} 5 ctx1abcde

486 

487 

488def test_no_response_model_annotation_return_class(): 5 ctx1abcde

489 response = client.get("/no_response_model-annotation_response_class") 5 ctx1abcde

490 assert response.status_code == 200, response.text 5 ctx1abcde

491 assert response.text == "Foo" 5 ctx1abcde

492 

493 

494def test_no_response_model_annotation_json_response_class(): 5 ctx1abcde

495 response = client.get("/no_response_model-annotation_json_response_class") 5 ctx1abcde

496 assert response.status_code == 200, response.text 5 ctx1abcde

497 assert response.json() == {"foo": "bar"} 5 ctx1abcde

498 

499 

500def test_invalid_response_model_field(): 5 ctx1abcde

501 app = FastAPI() 5 ctx1abcde

502 with pytest.raises(FastAPIError) as e: 5 ctx1abcde

503 

504 @app.get("/") 5 ctx1abcde

505 def read_root() -> Union[Response, None]: 5 ctx1abcde

506 return Response(content="Foo") # pragma: no cover 

507 

508 assert "valid Pydantic field type" in e.value.args[0] 5 ctx1abcde

509 assert "parameter response_model=None" in e.value.args[0] 5 ctx1abcde

510 

511 

512def test_openapi_schema(): 5 ctx1abcde

513 response = client.get("/openapi.json") 5 ctx1abcde

514 assert response.status_code == 200, response.text 5 ctx1abcde

515 assert response.json() == { 5 ctx1abcde

516 "openapi": "3.1.0", 

517 "info": {"title": "FastAPI", "version": "0.1.0"}, 

518 "paths": { 

519 "/no_response_model-no_annotation-return_model": { 

520 "get": { 

521 "summary": "No Response Model No Annotation Return Model", 

522 "operationId": "no_response_model_no_annotation_return_model_no_response_model_no_annotation_return_model_get", 

523 "responses": { 

524 "200": { 

525 "description": "Successful Response", 

526 "content": {"application/json": {"schema": {}}}, 

527 } 

528 }, 

529 } 

530 }, 

531 "/no_response_model-no_annotation-return_dict": { 

532 "get": { 

533 "summary": "No Response Model No Annotation Return Dict", 

534 "operationId": "no_response_model_no_annotation_return_dict_no_response_model_no_annotation_return_dict_get", 

535 "responses": { 

536 "200": { 

537 "description": "Successful Response", 

538 "content": {"application/json": {"schema": {}}}, 

539 } 

540 }, 

541 } 

542 }, 

543 "/response_model-no_annotation-return_same_model": { 

544 "get": { 

545 "summary": "Response Model No Annotation Return Same Model", 

546 "operationId": "response_model_no_annotation_return_same_model_response_model_no_annotation_return_same_model_get", 

547 "responses": { 

548 "200": { 

549 "description": "Successful Response", 

550 "content": { 

551 "application/json": { 

552 "schema": {"$ref": "#/components/schemas/User"} 

553 } 

554 }, 

555 } 

556 }, 

557 } 

558 }, 

559 "/response_model-no_annotation-return_exact_dict": { 

560 "get": { 

561 "summary": "Response Model No Annotation Return Exact Dict", 

562 "operationId": "response_model_no_annotation_return_exact_dict_response_model_no_annotation_return_exact_dict_get", 

563 "responses": { 

564 "200": { 

565 "description": "Successful Response", 

566 "content": { 

567 "application/json": { 

568 "schema": {"$ref": "#/components/schemas/User"} 

569 } 

570 }, 

571 } 

572 }, 

573 } 

574 }, 

575 "/response_model-no_annotation-return_invalid_dict": { 

576 "get": { 

577 "summary": "Response Model No Annotation Return Invalid Dict", 

578 "operationId": "response_model_no_annotation_return_invalid_dict_response_model_no_annotation_return_invalid_dict_get", 

579 "responses": { 

580 "200": { 

581 "description": "Successful Response", 

582 "content": { 

583 "application/json": { 

584 "schema": {"$ref": "#/components/schemas/User"} 

585 } 

586 }, 

587 } 

588 }, 

589 } 

590 }, 

591 "/response_model-no_annotation-return_invalid_model": { 

592 "get": { 

593 "summary": "Response Model No Annotation Return Invalid Model", 

594 "operationId": "response_model_no_annotation_return_invalid_model_response_model_no_annotation_return_invalid_model_get", 

595 "responses": { 

596 "200": { 

597 "description": "Successful Response", 

598 "content": { 

599 "application/json": { 

600 "schema": {"$ref": "#/components/schemas/User"} 

601 } 

602 }, 

603 } 

604 }, 

605 } 

606 }, 

607 "/response_model-no_annotation-return_dict_with_extra_data": { 

608 "get": { 

609 "summary": "Response Model No Annotation Return Dict With Extra Data", 

610 "operationId": "response_model_no_annotation_return_dict_with_extra_data_response_model_no_annotation_return_dict_with_extra_data_get", 

611 "responses": { 

612 "200": { 

613 "description": "Successful Response", 

614 "content": { 

615 "application/json": { 

616 "schema": {"$ref": "#/components/schemas/User"} 

617 } 

618 }, 

619 } 

620 }, 

621 } 

622 }, 

623 "/response_model-no_annotation-return_submodel_with_extra_data": { 

624 "get": { 

625 "summary": "Response Model No Annotation Return Submodel With Extra Data", 

626 "operationId": "response_model_no_annotation_return_submodel_with_extra_data_response_model_no_annotation_return_submodel_with_extra_data_get", 

627 "responses": { 

628 "200": { 

629 "description": "Successful Response", 

630 "content": { 

631 "application/json": { 

632 "schema": {"$ref": "#/components/schemas/User"} 

633 } 

634 }, 

635 } 

636 }, 

637 } 

638 }, 

639 "/no_response_model-annotation-return_same_model": { 

640 "get": { 

641 "summary": "No Response Model Annotation Return Same Model", 

642 "operationId": "no_response_model_annotation_return_same_model_no_response_model_annotation_return_same_model_get", 

643 "responses": { 

644 "200": { 

645 "description": "Successful Response", 

646 "content": { 

647 "application/json": { 

648 "schema": {"$ref": "#/components/schemas/User"} 

649 } 

650 }, 

651 } 

652 }, 

653 } 

654 }, 

655 "/no_response_model-annotation-return_exact_dict": { 

656 "get": { 

657 "summary": "No Response Model Annotation Return Exact Dict", 

658 "operationId": "no_response_model_annotation_return_exact_dict_no_response_model_annotation_return_exact_dict_get", 

659 "responses": { 

660 "200": { 

661 "description": "Successful Response", 

662 "content": { 

663 "application/json": { 

664 "schema": {"$ref": "#/components/schemas/User"} 

665 } 

666 }, 

667 } 

668 }, 

669 } 

670 }, 

671 "/no_response_model-annotation-return_invalid_dict": { 

672 "get": { 

673 "summary": "No Response Model Annotation Return Invalid Dict", 

674 "operationId": "no_response_model_annotation_return_invalid_dict_no_response_model_annotation_return_invalid_dict_get", 

675 "responses": { 

676 "200": { 

677 "description": "Successful Response", 

678 "content": { 

679 "application/json": { 

680 "schema": {"$ref": "#/components/schemas/User"} 

681 } 

682 }, 

683 } 

684 }, 

685 } 

686 }, 

687 "/no_response_model-annotation-return_invalid_model": { 

688 "get": { 

689 "summary": "No Response Model Annotation Return Invalid Model", 

690 "operationId": "no_response_model_annotation_return_invalid_model_no_response_model_annotation_return_invalid_model_get", 

691 "responses": { 

692 "200": { 

693 "description": "Successful Response", 

694 "content": { 

695 "application/json": { 

696 "schema": {"$ref": "#/components/schemas/User"} 

697 } 

698 }, 

699 } 

700 }, 

701 } 

702 }, 

703 "/no_response_model-annotation-return_dict_with_extra_data": { 

704 "get": { 

705 "summary": "No Response Model Annotation Return Dict With Extra Data", 

706 "operationId": "no_response_model_annotation_return_dict_with_extra_data_no_response_model_annotation_return_dict_with_extra_data_get", 

707 "responses": { 

708 "200": { 

709 "description": "Successful Response", 

710 "content": { 

711 "application/json": { 

712 "schema": {"$ref": "#/components/schemas/User"} 

713 } 

714 }, 

715 } 

716 }, 

717 } 

718 }, 

719 "/no_response_model-annotation-return_submodel_with_extra_data": { 

720 "get": { 

721 "summary": "No Response Model Annotation Return Submodel With Extra Data", 

722 "operationId": "no_response_model_annotation_return_submodel_with_extra_data_no_response_model_annotation_return_submodel_with_extra_data_get", 

723 "responses": { 

724 "200": { 

725 "description": "Successful Response", 

726 "content": { 

727 "application/json": { 

728 "schema": {"$ref": "#/components/schemas/User"} 

729 } 

730 }, 

731 } 

732 }, 

733 } 

734 }, 

735 "/response_model_none-annotation-return_same_model": { 

736 "get": { 

737 "summary": "Response Model None Annotation Return Same Model", 

738 "operationId": "response_model_none_annotation_return_same_model_response_model_none_annotation_return_same_model_get", 

739 "responses": { 

740 "200": { 

741 "description": "Successful Response", 

742 "content": {"application/json": {"schema": {}}}, 

743 } 

744 }, 

745 } 

746 }, 

747 "/response_model_none-annotation-return_exact_dict": { 

748 "get": { 

749 "summary": "Response Model None Annotation Return Exact Dict", 

750 "operationId": "response_model_none_annotation_return_exact_dict_response_model_none_annotation_return_exact_dict_get", 

751 "responses": { 

752 "200": { 

753 "description": "Successful Response", 

754 "content": {"application/json": {"schema": {}}}, 

755 }