Coverage for docs_src/additional_responses/tutorial003.py: 100%

1from fastapi import FastAPI 5 ctx1abcde

2from fastapi.responses import JSONResponse 5 ctx1abcde

3from pydantic import BaseModel 5 ctx1abcde

4 

5 

6class Item(BaseModel): 5 ctx1abcde

7 id: str 5 ctx1abcde

8 value: str 5 ctx1abcde

9 

10 

11class Message(BaseModel): 5 ctx1abcde

12 message: str 5 ctx1abcde

13 

14 

15app = FastAPI() 5 ctx1abcde

16 

17 

18@app.get( 5 ctx1abcde

19 "/items/{item_id}", 

20 response_model=Item, 

21 responses={ 

22 404: {"model": Message, "description": "The item was not found"}, 

23 200: { 

24 "description": "Item requested by ID", 

25 "content": { 

26 "application/json": { 

27 "example": {"id": "bar", "value": "The bar tenders"} 

28 } 

29 }, 

30 }, 

31 }, 

32) 

33async def read_item(item_id: str): 5 ctx1abcde

34 if item_id == "foo": 5 ctx1abcde

35 return {"id": "foo", "value": "there goes my hero"} 5 ctx1abcde

36 else: 

37 return JSONResponse(status_code=404, content={"message": "Item not found"}) 5 ctx1abcde