Deployment
runapi init my-api --docker
cd my-api
runapi build -t my-api
docker run -p 8000:8000 -e SECRET_KEY=... -e DEBUG=false my-api
Production checklist
runapi start runs in production mode (ENVIRONMENT=production) and refuses to start when:
SECRET_KEYis the default valueDEBUGis enabledCORS_ORIGINS=*is combined withCORS_CREDENTIALS=true
Also set specific CORS_ORIGINS and ALLOWED_HOSTS. Run runapi doctor to check your configuration.
Real environment variables override values in .env, so inject secrets through your platform.
Health checks
GET /health (liveness) and GET /ready (readiness) are built in. Add checks:
runapi_app.add_readiness_check("db", lambda: db.ping())
Startup and shutdown
@runapi_app.on_startup
async def connect(): ...
@runapi_app.on_shutdown
async def disconnect(): ...
Route files that fail to import abort startup in production (STRICT_ROUTES).
Configuration & logging
Settings are typed and validated at startup; a bad value (for example PORT=abc) stops the app with a message naming the variable.
Set LOG_JSON=true (the default when ENVIRONMENT=production) for JSON logs. Every request carries an X-Request-ID header, which also appears in your logs:
from runapi import get_request_id
request_id = get_request_id()
Multiple workers: Redis
Rate limiting and token revocation are per-process by default. With WORKERS > 1 (or several containers) share them via Redis:
pip install "runapi[redis]"
CACHE_BACKEND=redis
REDIS_URL=redis://localhost:6379/0
Behind a reverse proxy you control, also set TRUST_PROXY_HEADERS=true so rate limits use the real client IP.