Current API
The ASP.NET Core host currently exposes application information and health
checks. There are no game, editor, account, database, or blob-storage endpoints.
Use development setup to run the API locally over
HTTPS; the default API origin is https://localhost:7000.
| Endpoint | Availability | Behavior |
|---|---|---|
GET /api/about |
All environments | Application name, informational version, API environment, and source revision |
GET /api/alive |
All environments | Plain-text liveness status from checks tagged live |
/health |
Development only, on the API origin | Readiness result from all registered health checks |
/alive |
Development only, on the API origin | Liveness result from checks tagged live |
/openapi/v1.json and /scalar |
Development only | OpenAPI description and interactive API documentation |
/api/about uses the AboutResponse contract.
Its JSON properties are applicationName, version, apiEnvironmentName, and
sourceRevision. The source revision comes from the deployment's SOURCE_SHA
and may be null in a local run. The
typed client
is the frontend entry point for this request.
Health checks are implemented in
ServiceDefaults.
The current self check reports process liveness. A passing /api/alive does not
prove frontend startup, a frontend-to-API request, or future dependency readiness.
The integration tests
cover environment availability and health-check failure behavior.
On a deployed host, Caddy proxies /api/* to the API and serves the web client.
Caddy's public /health is an edge response, distinct from the API's
Development-only readiness endpoint. See hosting for
routing and testing for the deployment browser smoke.