JNZader add-main-endpoint
This skill covers adding main endpoints to the FastAPI application.
Trigger: When setting up the main entry point for the application.
Quick Reference
| Task | Pattern |
|---|---|
| Add health check | health |
| Add detailed health | health_detailed |
Critical Patterns (Summary)
- health: Implements a basic health check endpoint.
- health_detailed: Implements a detailed health check endpoint.
Critical Patterns (Detailed)
health
Implements a basic health check endpoint to verify the service is running.
from fastapi import FastAPI
app = FastAPI()
@app.get("/health")
async def health():
return {"status": "healthy"}
health_detailed
Implements a detailed health check endpoint providing more information about the service status.
from fastapi import FastAPI
app = FastAPI()
@app.get("/health/detailed")
async def health_detailed():
return {"status": "healthy", "details": "All systems operational"}
When to Use
- When you need to expose a health check endpoint for monitoring.
- When you want to provide detailed service status for diagnostics.
Commands
docker run -d -p 8000:8000 your-image-name
Anti-Patterns
Don't: Expose sensitive data in health checks
Exposing sensitive information can lead to security vulnerabilities.
# BAD
@app.get("/health/detailed")
async def health_detailed():
return {"status": "healthy", "db_status": "connected", "secret_key": "12345"}