https://github.com/adriangb/asapi
An opinionated set of utilities / patterns for FastAPI
https://github.com/adriangb/asapi
Last synced: 7 days ago
JSON representation
An opinionated set of utilities / patterns for FastAPI
- Host: GitHub
- URL: https://github.com/adriangb/asapi
- Owner: adriangb
- Created: 2024-05-31T10:06:08.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-02-05T16:38:08.000Z (3 months ago)
- Last Synced: 2025-04-16T15:13:50.174Z (10 days ago)
- Language: Python
- Size: 135 KB
- Stars: 25
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# asapi
A thin opinionated wrapper around FastAPI. Because it's wrapping FastAPI you can work it into your existing projects.
## Explicit composition root
FastAPI uses callbacks inside of `Depends` to do it's dependency injection.
This forces you to end up using multiple layers of `Depends` to compose your application.
The creation of these `Depends` resources often ends up distributed across modules so it's hard to know where something is initialized.
FastAPI also has no application-level dependencies, so you end up having to use globals to share resources across requests.
`asapi` solves this by having an explicit composition root where you can define all your dependencies in one place.
Endpoints then use `Injected[DependencyType]` to get access to the dependencies they need.
## Example
```python
from __future__ import annotations
import anyio
from fastapi import FastAPI
from psycopg_pool import AsyncConnectionPool
from asapi import FromPath, Injected, serve, bind
app = FastAPI()
@app.get("/hello/{name}")
async def hello(
name: FromPath[str],
pool: Injected[AsyncConnectionPool],
) -> str:
async with pool.connection() as conn:
async with conn.cursor() as cur:
await cur.execute("SELECT '¡Hola ' || %(name)s || '!'", {"name": name})
res = await cur.fetchone()
assert res is not None
return res[0]
```
TODO: in the future I'd like to provide a wrapper around `APIRouter` and `FastAPI` that also forces you to mark every argument to an endpoint as `Injected`, `Query`, `Path`, `Body`, which makes it explicit where arguments are coming from with minimal boilerplate.
## Run in your event loop
FastAPI recommends using Uvicorn to run your application (note: if you're using Gunicorn you probably don't need to unless you're deploying on a a 'bare meta' server with multiple cores like a large EC2 instance).
But using `uvicorn app:app` from the command line has several issues:
1. It takes control of the event loop and startup out of your hands. You have to rely on Uvicorn to configure the event loop, configure logging, etc.
2. You'll have to use ASGI lifespans to initialize your resources, or the globals trick mentioned above.
3. You can't run anything else in the event loop (e.g. a background worker).
`asapi` solves this by providing a `serve` function that you can use to run your application in your own event loop.
```python
from __future__ import annotations
import anyio
from asapi import serve
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root() -> dict[str, str]:
return {"message": "Hello World"}
async def main():
await serve(app, 8000)
if __name__ == "__main__":
anyio.run(main)
```
Now you have full control of the event loop and can make database connections, run background tasks, etc.
Combined with the explicit composition root, you can initialize all your resources in one place, bind them to an application instance that is specific to this event loop and inject them into the endpoints that need them, all without global state or multiple layers of `Depends`.
```python
from __future__ import annotations
import logging
from typing import Any
import anyio
from fastapi import FastAPI, APIRouter
from psycopg_pool import AsyncConnectionPool
from asapi import FromPath, Injected, serve, bind
router = APIRouter()
@router.get("/hello/{name}")
async def hello(name: FromPath[str], pool: Injected[AsyncConnectionPool]) -> str:
async with pool.connection() as conn:
async with conn.cursor() as cur:
await cur.execute("SELECT '¡Hola ' || %(name)s || '!'", {"name": name})
res = await cur.fetchone()
assert res is not None
return res[0]
def create_app(pool: AsyncConnectionPool[Any]) -> FastAPI:
app = FastAPI()
bind(app, AsyncConnectionPool, pool)
app.include_router(router)
return app
async def main() -> None:
logging.basicConfig(level=logging.INFO)
async with AsyncConnectionPool(
"postgres://postgres:postgres@localhost:54320/postgres"
) as pool:
app = create_app(pool)
await serve(app, 9000)
if __name__ == "__main__":
anyio.run(main)
```