mirror of
https://github.com/fastapi/fastapi.git
synced 2026-01-05 12:38:54 -05:00
313bbe802f
* ✨ Add Default and DefaultPlaceholder data structures to handle defaults and overrides * ✨ Add utils to get values by priority handling DefaultPlaceholders * ✨ Add support for top-level parameters in FastAPI, APIRouter, include_router including: prefix, tags, dependencies, deprecated, include_in_schema, responses, default_response_class, callbacks * ♻️ Update openapi utils to handle DefaultPlaceholder for response_class * 📝 Update bigger-application example code to use top-level params and showcase them in APIRouter, FastAPI, include_router * 📝 Update docs for Bigger Applications, include diagrams, top-level params * 🔥 Simplify code and docs for callbacks as default_response_class is no longer required * 📝 Add docs for top-level dependencies, in FastAPI() * 📝 Add docs reference to top-level dependencies in docs for decorator * ✅ Update/increase tests for Bigger Applications including shared parameters * ✅ Add tests for top-level dependencies in FastAPI() * ✅ Add tests for internal DefaultPlaceholder * ✅ Update/increase tests for callbacks with top-level parameters * ✅ Add LOTS of tests covering branches and cases for shared parameters in top-level FastAPI, path operations, include_router, APIRouter, its path operations, nested include_router, nested APIRouter, and its path operations * 🎨 Format/reorder parameters for consistency in FastAPI, APIRouter, include_router
54 lines
1.3 KiB
Python
54 lines
1.3 KiB
Python
from typing import Optional
|
|
|
|
from fastapi import APIRouter, FastAPI
|
|
from pydantic import BaseModel, HttpUrl
|
|
|
|
app = FastAPI()
|
|
|
|
|
|
class Invoice(BaseModel):
|
|
id: str
|
|
title: Optional[str] = None
|
|
customer: str
|
|
total: float
|
|
|
|
|
|
class InvoiceEvent(BaseModel):
|
|
description: str
|
|
paid: bool
|
|
|
|
|
|
class InvoiceEventReceived(BaseModel):
|
|
ok: bool
|
|
|
|
|
|
invoices_callback_router = APIRouter()
|
|
|
|
|
|
@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: Optional[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"}
|