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

1from typing import Union 7 ctx1abcdefg

2 

3from fastapi import APIRouter, FastAPI 7 ctx1abcdefg

4from pydantic import BaseModel, HttpUrl 7 ctx1abcdefg

5 

6app = FastAPI() 7 ctx1abcdefg

7 

8 

9class Invoice(BaseModel): 7 ctx1abcdefg

10 id: str 7 ctx1abcdefg

11 title: Union[str, None] = None 7 ctx1abcdefg

12 customer: str 7 ctx1abcdefg

13 total: float 7 ctx1abcdefg

14 

15 

16class InvoiceEvent(BaseModel): 7 ctx1abcdefg

17 description: str 7 ctx1abcdefg

18 paid: bool 7 ctx1abcdefg

19 

20 

21class InvoiceEventReceived(BaseModel): 7 ctx1abcdefg

22 ok: bool 7 ctx1abcdefg

23 

24 

25invoices_callback_router = APIRouter() 7 ctx1abcdefg

26 

27 

28@invoices_callback_router.post( 7 ctx1abcdefg

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

30) 

31def invoice_notification(body: InvoiceEvent): 7 ctx1abcdefg

32 pass 7 ctx1hijklmn

33 

34 

35@app.post("/invoices/", callbacks=invoices_callback_router.routes) 7 ctx1abcdefg

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

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"} 7 ctx1opqrstu