API Gateway Template — Parameters¶
Discovery¶
Exact flags depend on the released installer. The gateway repo composes metadata from Base plus template/apigateway.template.extend.json; the stub .template.config/template.json may not list every symbol.
Inherited from Base¶
Many core symbols (ports, Docker, Logging, OpenTelemetry, persistence toggles if present, etc.) come from ConnectSoft.BaseTemplate template definition. See Base Template — Parameters for the full kernel catalog.
Gateway-specific conditional flags¶
The Layer 3 extend file drives source exclusions when features are off. Engineers commonly see symbols aligned with these conditions (names may vary slightly by version—verify in apigateway.template.extend.json):
| Feature area | Example symbol | When disabled, excludes (examples) |
|---|---|---|
| Application Insights | UseApplicationInsights |
AzureApplicationInsightsExtensions.cs |
| Health | HealthCheck |
HealthChecksExtensions.cs |
| Swagger | Swagger |
Swagger UI assets, SwaggerExtensions.cs |
| Scalar | Scalar |
ScalarExtensions.cs |
| Rate limiting | RateLimiting |
RateLimitingExtensions.cs |
| Compression | Compression |
Compression extensions + tests |
| OpenTelemetry | OpenTelemetry |
OTel tracer builder helpers |
| Collector stacks | UseOtelCollector, UsePrometheusGrafana, UseJaegerBackend, UseElkStack, UseSeqBackend |
Compose files, k8s manifests, scripts |
| Feature flags | FeatureFlags |
FeatureFlagsExtensions.cs |
| Resource monitoring | ResourceMonitoring |
ResourceMonitoringExtensions.cs |
| Distributed cache | DistributedCacheInMemory, DistributedCacheRedis |
respective extension classes |
| SignalR | UseSignalR |
ServiceModel.SignalR, tests |
Additional configuration provider branches (e.g. none vs Azure App Configuration) also trim optional extensions—search AdditionalConfigurationProviderNone in the extend JSON.
Operational guidance¶
- Prefer
dotnet new ... -hover copying flags from old docs. - When CI composes
template.json, ensure local template author docs match the published nuspec version.