mirror of
https://github.com/fastapi/fastapi.git
synced 2026-01-08 06:01:29 -05:00
0ac9b3ee5c
* ✨ Re-export main features used from Starlette to simplify developer's code * ♻️ Refactor Starlette exports * ♻️ Refactor tutorial examples to use re-exported utils from Starlette * 📝 Add examples for all middlewares * 📝 Add new docs for middlewares * 📝 Add examples for custom responses * 📝 Extend docs for custom responses * 📝 Update docs and add notes explaining re-exports from Starlette everywhere * 🍱 Update screenshot for HTTP status * 🔧 Update MkDocs config with new content * ♻️ Refactor tests to use re-exported utils from Starlette * ✨ Re-export WebSocketDisconnect from Starlette for tests * ✅ Add extra tests for extra re-exported middleware * ✅ Add tests for re-exported responses from Starlette * ✨ Add docs about mounting WSGI apps * ➕ Add Flask as a dependency to test WSGIMiddleware * ✅ Test WSGIMiddleware example
53 lines
1.4 KiB
Python
53 lines
1.4 KiB
Python
from fastapi import APIRouter, FastAPI
|
|
from fastapi.responses import JSONResponse
|
|
from pydantic import BaseModel, HttpUrl
|
|
|
|
app = FastAPI()
|
|
|
|
|
|
class Invoice(BaseModel):
|
|
id: str
|
|
title: str = None
|
|
customer: str
|
|
total: float
|
|
|
|
|
|
class InvoiceEvent(BaseModel):
|
|
description: str
|
|
paid: bool
|
|
|
|
|
|
class InvoiceEventReceived(BaseModel):
|
|
ok: bool
|
|
|
|
|
|
invoices_callback_router = APIRouter(default_response_class=JSONResponse)
|
|
|
|
|
|
@invoices_callback_router.post(
|
|
"{$callback_url}/invoices/{$request.body.id}", response_model=InvoiceEventReceived,
|
|
)
|
|
def invoice_notification(body: InvoiceEvent):
|
|
pass
|
|
|
|
|
|
@app.post("/invoices/", callbacks=invoices_callback_router.routes)
|
|
def create_invoice(invoice: Invoice, callback_url: HttpUrl = None):
|
|
"""
|
|
Create an invoice.
|
|
|
|
This will (let's imagine) let the API user (some external developer) create an
|
|
invoice.
|
|
|
|
And this path operation will:
|
|
|
|
* Send the invoice to the client.
|
|
* Collect the money from the client.
|
|
* Send a notification back to the API user (the external developer), as a callback.
|
|
* At this point is that the API will somehow send a POST request to the
|
|
external API with the notification of the invoice event
|
|
(e.g. "payment successful").
|
|
"""
|
|
# Send the invoice, collect the money, send the notification (the callback)
|
|
return {"msg": "Invoice received"}
|