Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paul121/fastapi-zeit-now
A simple example of deploying FastAPI as a Zeit Serverless Function
https://github.com/paul121/fastapi-zeit-now
asgi fastapi serverless starlette zeit
Last synced: about 2 months ago
JSON representation
A simple example of deploying FastAPI as a Zeit Serverless Function
- Host: GitHub
- URL: https://github.com/paul121/fastapi-zeit-now
- Owner: paul121
- Created: 2020-03-05T05:29:29.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-05T17:54:45.000Z (11 months ago)
- Last Synced: 2024-10-12T01:44:03.874Z (2 months ago)
- Topics: asgi, fastapi, serverless, starlette, zeit
- Language: Python
- Homepage: https://fastapi-zeit-now.now.sh
- Size: 11.7 KB
- Stars: 28
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://fastapi-zeit-now.paul121.now.sh/?name=GithubUser)_**
- OpenAPI Docs: [https://fastapi-zeit-now.paul121.now.sh/docs](https://fastapi-zeit-now.paul121.now.sh/docs)
- Try the API endpoints [/?name=Name](https://fastapi-zeit-now.paul121.now.sh/?name=Name), [/users](https://fastapi-zeit-now.paul121.now.sh/users), [/items](https://fastapi-zeit-now.paul121.now.sh/items)
Notes about this deployment:
- FastAPI is configured to return a `Cache-Control` header set to `no-cache` for 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](https://zeit.co/docs/v2/network/caching).
- This repo contains a sample sqlite database that has a few predefined `users` and `items` to 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](https://github.com/tiangolo/fastapi/issues/812))
[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](https://zeit.co/docs/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](https://github.com/zeit/now/issues/3729#issuecomment-582114686)).
I couldn't get `rewrite` to work, but did have success routing all requests to one FastAPI function:
```json
"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`:
```json
"builds": [
{ "src": "/app/main.py", "use": "@now/python" }
]
```
[FastAPI]: https://fastapi.tiangolo.com
[FastAPI SQL Databases Tutorial]:https://fastapi.tiangolo.com/tutorial/sql-databases/#review-all-the-files
[Zeit]: https://zeit.co
[Zeit Now]: https://github.com/zeit/now/tree/master/packages/now-cli
[Asynchronous Server Gateway Interface (ASGI)]: https://zeit.co/docs/runtimes#advanced-usage/advanced-python-usage/asynchronous-server-gateway-interface
[Zeit Routes]: https://zeit.co/docs/configuration#project/routes
[Zappa]: https://github.com/Miserlou/Zappa
[Mangum]: https://github.com/erm/mangum