Coverage for docs_src / openapi_callbacks / tutorial001_py310.py: 100%

1from fastapi import APIRouter, FastAPI 3 ctx1abc

2from pydantic import BaseModel, HttpUrl 3 ctx1abc

3 

4app = FastAPI() 3 ctx1abc

5 

6 

7class Invoice(BaseModel): 3 ctx1abc

8 id: str 3 ctx1abc

9 title: str | None = None 3 ctx1abc

10 customer: str 3 ctx1abc

11 total: float 3 ctx1abc

12 

13 

14class InvoiceEvent(BaseModel): 3 ctx1abc

15 description: str 3 ctx1abc

16 paid: bool 3 ctx1abc

17 

18 

19class InvoiceEventReceived(BaseModel): 3 ctx1abc

20 ok: bool 3 ctx1abc

21 

22 

23invoices_callback_router = APIRouter() 3 ctx1abc

24 

25 

26@invoices_callback_router.post( 3 ctx1abc

27 "{$callback_url}/invoices/{$request.body.id}", response_model=InvoiceEventReceived 

28) 

29def invoice_notification(body: InvoiceEvent): 3 ctx1abc

30 pass 3 ctx1def

31 

32 

33@app.post("/invoices/", callbacks=invoices_callback_router.routes) 3 ctx1abc

34def create_invoice(invoice: Invoice, callback_url: HttpUrl | None = None): 3 ctx1abc

35 """ 

36 Create an invoice. 

37 

38 This will (let's imagine) let the API user (some external developer) create an 

39 invoice. 

40 

41 And this path operation will: 

42 

43 * Send the invoice to the client. 

44 * Collect the money from the client. 

45 * Send a notification back to the API user (the external developer), as a callback. 

46 * At this point is that the API will somehow send a POST request to the 

47 external API with the notification of the invoice event 

48 (e.g. "payment successful"). 

49 """ 

50 # Send the invoice, collect the money, send the notification (the callback) 

51 return {"msg": "Invoice received"} 3 ctx1ghi