Skip to main content

Service template

Copy docs/services/backend-java/auth-service/ when you add a backend service. Keep the filenames so the sidebar stays predictable.

FileContents
index.mdPurpose, bounded context, port, schema, Kong prefixes
architecture.mdLayers, use cases, a small diagram
api.mdControllers and paths, auth, link to OpenAPI
data-model.mdTables from Flyway, who is allowed to write them
events.mdProduced and consumed streams, consumer group names
dependencies.mdHTTP clients, Redis, object storage, providers
configuration.mdProfile names and env names
observability.mdLog fields, metrics, dashboards, alerts
jobs.mdSchedulers and workers, or an explicit "none"
runbook.mdHealthy signals, failure modes, what not to delete
testing.mdHow 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.