Skip to content
Navigation Menu
Sign in
Products
Platform
GitHub
Repository hosting, code review, and collaboration
Copilot
AI coding agent for tasks, projects, and automated work
Build & Ship
Actions
CI/CD and automation
Code Quality
Quality analysis, fixes, and enforcement
Codespaces
Cloud development environments
Secure
Code Security
Vulnerability detection and remediation
Secret Protection
Secret scanning and leak prevention
All Features
Developers
Learn
Documentation
Training
Certifications
Build
Build with Copilot
Customize Copilot
Integrations
Explore
Trending repos
GitHub Sponsors
Developer articles
Changelog
Changelog
Your source for the latest features, improvements, and fixes across GitHub products, all in one place.
Businesses
By Stage
Enterprises
Team
Startups
Nonprofits
By Industry
Healthcare
Financial services
Manufacturing
Government
See all industries
Evaluate GitHub
Why GitHub
Customer Stories
Business insights
Trust Center
Add-ons
GitHub Advanced Security
Enterprise-grade code security
Copilot for business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Resources
Learn & Connect
Documentation
Resource center
Blog
Events & webinars
Community Forum
Customer Stories
Integrations
Support
Customer support
Training
GitHub Status
Company
About
Partners
Changelog
GitHub Universe
GitHub Universe
The event for developers, by developers — talks, workshops, and what’s next for GitHub.
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
kosc
fastapi
Repository navigation
Code
Pull requests
8
(8)
Actions
Projects
Security and quality
Insights
More
items
Files
Expand file tree
master
Breadcrumbs
fastapi
/
docs_src
/
openapi_callbacks
/
tutorial001.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
53 lines (36 loc) · 1.34 KB
master
Breadcrumbs
fastapi
/
docs_src
/
openapi_callbacks
/
tutorial001.py
Copy path
Top
File metadata and controls
Code
Blame
53 lines (36 loc) · 1.34 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
from
typing
import
Union
from
fastapi
import
APIRouter
,
FastAPI
from
pydantic
import
BaseModel
,
HttpUrl
app
=
FastAPI
()
class
Invoice
(
BaseModel
):
id
:
str
title
:
Union
[
str
,
None
]
=
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
:
Union
[
HttpUrl
,
None
]
=
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"
}
You can’t perform that action at this time.