📚 Developer Handbook & Wiki
This page serves as a high-density reference for the API Reliability Suite. For detailed explanations, refer to the specific guides listed in the Reference Index.
🏗️ Technical Stack
| Component |
Technology |
Why? |
| Language |
Python 3.12+ |
Performance, Type safety, Ecosystem. |
| Framework |
FastAPI |
Async-first, Auto-validation (Pydantic). |
| Lint/Format |
Ruff |
100x faster than traditional tools. |
| Logging |
Structlog |
JSON production-ready logging. |
| Observability |
OpenTelemetry |
Vendor-neutral tracing standard. |
🚨 Emergency & Common Commands
| Scenario |
Command |
| Full Stack Start |
make stack-up |
| Full Stack Stop |
make stack-down |
| AI Log Analysis |
make debug |
| Run Regression Tests |
make test |
| Fix Linting/Format |
make format |
📖 Reference Index
- Development Guide: Complete development setup, workflow, and contribution guidelines
- Configuration Guide: All configuration options and environment variables
- Security Guide: Authentication, authorization, and security best practices
- Deployment Guide: Docker, Kubernetes, and cloud deployment strategies
- Performance Guide: Optimization, monitoring, and performance tuning
- Architecture Deep Dive: Implementation of patterns and Hexagonal design
- Reliability Features: Overview of Circuit Breakers, Rate Limiting, and AI Triage
- Monitoring Guide: How to use Grafana Dashboards and Jaeger Traces
- Setup Guide: Environment configuration and Docker setup
- API Reference: Interactive Swagger UI and endpoint details
- Troubleshooting: Common issues and solutions
🤝 Contribution Rules
- Commit Style: Use Conventional Commits.
- Quality Gates:
make format and make test must pass before any PR.
- ADRs: Major design shifts require a new file in
docs/adr/.