Skip to main content

Repo Tour

High-level layout​

  • cmd/: CLI entrypoints (apigw is the primary runtime CLI).
  • pkg/gateway/: SDK surface + gateway runtime packages (config, server, proxy, auth, metrics).
  • internal/: supporting services (OpenAPI merge, readiness/health, shadow diff tooling).
  • specs/: OpenAPI fragments merged into dist/openapi.json.
  • test/acceptance/: black-box acceptance tests that exercise the gateway behavior.
  • docs/: Docusaurus documentation site (you are here).
  • docs-archive/: previous markdown docs (preserved during migration).

Where to start reading code​

  1. CLI wiring (cmd/apigw/main.go)
  2. Runtime composition (pkg/gateway/runtime/runtime.go)
  3. HTTP server + routes (pkg/gateway/server/server.go)
  4. Proxy behavior (pkg/gateway/proxy/reverse_proxy.go)
  5. Config schema + loader (pkg/gateway/config/config.go)

See also​