Skip to content

README.md

Latest commit

 

History

History
43 lines (28 loc) · 1.04 KB

README.md

File metadata and controls

43 lines (28 loc) · 1.04 KB
Raw

API documentation

HTTP API contracts for the Open Insurance platform.

Source of truth

Surface Location
REST (public, via Kong) openapi.yaml
gRPC (internal / future) ../../proto/
Gateway routing ../../gateway/kong/

Document gateway paths (/identity/..., /application/...) in OpenAPI — not internal Docker hostnames.

View locally

make api-docs

Opens an interactive reference at http://localhost:8089 (Redocly). Requires Node.js/npx or Docker.

Validate the spec without starting a server:

make api-lint

Editing workflow

  1. Update openapi.yaml when adding or changing HTTP endpoints.
  2. Run make api-lint before opening a PR.
  3. Keep request/response shapes aligned with Go handlers under services/*/.

Authentication

POST /identity/auth/login returns a Bearer JWT. Configure signing via JWT_SECRET, JWT_ISSUER, and JWT_ACCESS_TTL in .env.

Seed a dev user:

make seed-user