FastAPI Zeit Now
Deploy a FastAPI app as a Zeit Serverless Function.
This repo deploys the FastAPI SQL Databases Tutorial to demonstrate how a FastAPI app can be deployed using the Zeit Asynchronous Server Gateway Interface (ASGI).
View the live demo at: https://fastapi-zeit-now.paul121.now.sh/?name=GithubUser
- OpenAPI Docs: https://fastapi-zeit-now.paul121.now.sh/docs
- Try the API endpoints /?name=Name, /users, /items
Notes about this deployment:
- FastAPI is configured to return a
Cache-Controlheader set tono-cachefor all responses. Because static caching is automatic with Zeit, this ensures the Zeit CDN doesn't cache anything for the purposes of this example. More on caching here. - This repo contains a sample sqlite database that has a few predefined
usersanditemsto demonstrate returning data from a database.- Note Due to the nature of a serverless deploy, the sqlite file cannot be written to so any POST requests attempting to modify the DB will fail.
- In a production deploy, the FastAPI app would connect to a database hosted elsewhere.
This is merely an example of integration with Zeit. I'm not currently deploying any FastAPI apps in this way, but would like to consider it a possibility. Any thoughts, concerns or ideas for benchmarking are welcome!!
Background
After learning about Zappa I was inspired to learn more about hosting FastAPI as a server-less function:
Zappa makes it super easy to build and deploy server-less, event-driven Python applications (including, but not limited to, WSGI web apps) on AWS Lambda + API Gateway. Think of it as "serverless" web hosting for your Python apps. That means infinite scaling, zero downtime, zero maintenance - and at a fraction of the cost of your current deployments!
The problem is that Zappa only works with WSGI Python apps such as Flask and Django, not ASGI.
Google Cloud Run and AWS Elastic Beanstalk are other alternatives, but don't support ASGI either.
I came across Mangum which is similar to Zappa, except it supports ASGI apps. While this would likely work with FastAPI (or most any ASGI Python app) it also seems to make some decisions about how you structure your app. And it still requires quite a bit of configuration with AWS to get everything working. (more in this issue)
Zeit Now makes this all a bit easier. Develop locally with now dev and deploy with now --prod.
Configuration
With Zeit Now, we just need to configure a few things in now.json, run now --prod and FastAPI is deployed.
See Zeit Docs on Configuration
Requirements
Define pip install requirements in a requirements.txt file.
Routing
Looking into this, the hardest thing to configure was Zeit Routes:
By default, routing is defined by the filesystem of your deployment. For example, if a user makes a request to /123.png, and your now.json file does not contain any routes with a valid src matching that path, it will fallback to the filesystem and serve /123.png if it exists.
This makes great sense for most serverless apps, but doesn't work so well with FastAPI when one function needs to respond to multiple routes (figured out in this issue).
I couldn't get rewrite to work, but did have success routing all requests to one FastAPI function:
"routes": [
{ "src": "/(.*)", "dest": "app/main.py" }
]
Defining Functions
By default Zeit also looks for Python apps in an index.py file at the root or in the /api directory. This is can be configured by adding a build configuration to now.json:
"builds": [
{ "src": "/app/main.py", "use": "@now/python" }
]
465 Jan 7, 2023
188 Dec 29, 2022
551 Dec 24, 2022
19 Dec 12, 2022
4 Aug 11, 2022
950 Jan 8, 2023
543 Jan 5, 2023
1.3k Jan 4, 2023
1k Jan 2, 2023
9 Nov 10, 2022
2 Jan 17, 2022
1 Jan 1, 2022
5 Dec 23, 2022
14 Dec 5, 2022
27 Oct 16, 2022
29 Nov 20, 2022
318 Dec 31, 2022
1 Dec 11, 2021