API Server
SKILL.md
Golang API Server Standards
Priority: P0 (CRITICAL)
Router Selection
- Standard Lib (
net/http): Use for simple services or when zero deps is required. Usehttp.ServeMux(Go 1.22+ has decent routing). - Echo (
labstack/echo): Recommended for production REST APIs. Excellent middleware support, binding, and error handling. - Gin (
gin-gonic/gin): High performance alternative.
Guidelines
- Graceful Shutdown: MUST implement graceful shutdown to handle in-flight requests on termination (SIGINT/SIGTERM).
- DTOs: Separate Domain structs from API Request/Response structs. Map between them.
- Middleware: Use middleware for cross-cutting concerns (Logging, Recovery, CORS, Auth, Tracing).
- Health Checks: Always include
/healthand/readyendpoints. - Content-Type: Enforce
application/jsonfor REST APIs.