API Gateway Template — Agent handbook¶
Role: Edge / BFF — routing, perimeter auth, throttling, observability at ingress.
Not for: Domain aggregates, long-lived business transactions, or OIDC token issuance (that is Authorization Server).
Canonical spec: ConnectSoft.Documentation — API Gateway
When agents select this template¶
| Scenario | Use gateway? |
|---|---|
| Single public HTTP entry for many microservices | Yes |
| Per-channel API shaping (mobile vs web) without copying domain | Yes (BFF) |
| Need issuing JWTs for clients | No → Authorization Server |
| Need user store / passwords | No → Identity Backend |
Composition¶
- Submodule:
base-template/→ ConnectSoft.BaseTemplate - Registration:
ApplicationModelRegistrationBase→MicroserviceRegistrationBase→ gateway-specific registration (e.g.ApiGatewayMicroserviceRegistration)
Packaging note for agents¶
CHECKED-IN .template.config/template.json may be a stub; CI may merge Base + template/apigateway.template.extend.json. For symbol truth on a build: dotnet new connectsoft-apigateway -h on the released installer.
Blueprint hints¶
edge: true
rate_limiting: true
bff: optional
jwt_validation: true # perimeter — not token issuance
downstream_services: [Orders, Billing]
Topic index (agents)¶
| Page | Use when |
|---|---|
| Architecture | Edge + tenancy + failure domain |
| Parameters | Conditional features (Swagger, OTel stacks, …) |
| Authentication | JWT vs Identity vs Auth Server |
| … | (see nav) |