Skip to content

API Gateway Template — Runbook (agents)

Agent intent

Deploy, probes, dashboards — especially K8s liveness/readiness for gateways & aggregators.

Template role: Edge / BFF host — YARP-style routing, JWT at perimeter, rate limits — not business domain.

Canonical technical documentation

Full prose, diagrams, and edge cases live in ConnectSoft.Documentation:

Runbook — public doc

Repository

  • Repo: ConnectSoft.ApiGatewayTemplateREADME.md, AGENTS.md
  • Installer (typical): ConnectSoft.ApiGatewayTemplate.Installer
  • Short name (typical): connectsoft-apigateway — confirm with dotnet new connectsoft-apigateway -h when applicable.

Agent checklist

  • Prefer public doc for long explanations; keep Factory responses actionable and short.
  • Do not embed secrets in generated appsettings; use env / KeyVault patterns per platform.
  • Cross-link Template Architecture when touching DI or layering.

  • Health aggregator: /alive vs /api/health/readiness per README.