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

1from typing import Union 5 ctx1abcde

2 

3from fastapi import APIRouter, FastAPI 5 ctx1abcde

4from pydantic import BaseModel, HttpUrl 5 ctx1abcde

5 

6app = FastAPI() 5 ctx1abcde

7 

8 

9class Invoice(BaseModel): 5 ctx1abcde

10 id: str 5 ctx1abcde

11 title: Union[str, None] = None 5 ctx1abcde

12 customer: str 5 ctx1abcde

13 total: float 5 ctx1abcde

14 

15 

16class InvoiceEvent(BaseModel): 5 ctx1abcde

17 description: str 5 ctx1abcde

18 paid: bool 5 ctx1abcde

19 

20 

21class InvoiceEventReceived(BaseModel): 5 ctx1abcde

22 ok: bool 5 ctx1abcde

23 

24 

25invoices_callback_router = APIRouter() 5 ctx1abcde

26 

27 

28@invoices_callback_router.post( 5 ctx1abcde

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

30) 

31def invoice_notification(body: InvoiceEvent): 5 ctx1abcde

32 pass 5 ctx1abcde

33 

34 

35@app.post("/invoices/", callbacks=invoices_callback_router.routes) 5 ctx1abcde

36def create_invoice(invoice: Invoice, callback_url: Union[HttpUrl, None] = None): 5 ctx1abcde

37 """ 

38 Create an invoice. 

39 

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

41 invoice. 

42 

43 And this path operation will: 

44 

45 * Send the invoice to the client. 

46 * Collect the money from the client. 

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

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

49 external API with the notification of the invoice event 

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

51 """ 

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

53 return {"msg": "Invoice received"} 5 ctx1abcde