Service template
Copy docs/services/backend-java/auth-service/ when you add a backend service. Keep the filenames so the sidebar stays predictable.
| File | Contents |
|---|---|
index.md | Purpose, bounded context, port, schema, Kong prefixes |
architecture.md | Layers, use cases, a small diagram |
api.md | Controllers and paths, auth, link to OpenAPI |
data-model.md | Tables from Flyway, who is allowed to write them |
events.md | Produced and consumed streams, consumer group names |
dependencies.md | HTTP clients, Redis, object storage, providers |
configuration.md | Profile names and env names |
observability.md | Log fields, metrics, dashboards, alerts |
jobs.md | Schedulers and workers, or an explicit "none" |
runbook.md | Healthy signals, failure modes, what not to delete |
testing.md | How to run tests, what kind they are |
Add _category_.json with a link to index.
Rust services, iOS packages, and Android modules use a shorter page: purpose, port or module path, the Java or API contract they must match, and any divergence. Do not duplicate the Java data model unless the divergence is the point.
Internal routes and admin routes are documented as internal. Do not copy them into a public client guide.