kra-new/internal/server/README.md

18 lines
778 B
Markdown

# Server Layer
The root package owns Gin server lifecycle and Swagger setup. HTTP concerns are
grouped by role:
- `handler/`: resource handlers and HTTP boundary validation
- `middleware/`: request metadata, auth, access control, audit, recovery, CORS
- `router/`: resource route registration and the system route registrar
- `httpx/`: system adapter for shared response and cookie helpers
Cross-cutting route policy lives in `internal/routecatalog`: public/private
Swagger security, operation-audit flags, sensitive request-body handling and
API group/description metadata must be declared there. Router contract tests
keep the catalog aligned with the Gin registrations.
Keep new files in the matching role directory instead of adding transport files
to the root package.