Deploy and Host Microcks API Contract Sandbox on Railway

Import API contracts, explore mock endpoints and run conformance tests.

Draft status: Configuration and upstream documentation reviewed. Container startup, Railway application workflows, restart behavior, backup restoration and costs remain unverified.

About Hosting

Import API contracts, explore mock endpoints and run conformance tests.

Service	Role	Persistent path
`app`	Private application or dependency	`None`
`microcks`	Public owner gateway	`None`

Why Deploy

Run this application in your own Railway project, with explicit configuration and storage under your control.

Common Use Cases

Import API contracts, explore mock endpoints and run conformance tests.

Dependencies for Microcks API Contract Sandbox

Deployment Dependencies

The application images are pinned by registry digest. Database services, when included, stay on the private network. One replica is supported for each volume-backed service.

First use

Open the microcks service's HTTPS domain. Sign in to the owner gateway with username admin and its generated ACCESS_PASSWORD. Complete the application's own setup afterward.

API calls must also send X-Template-Key with that owner password. The gateway forwards native Bearer tokens, strips Basic Authorization, and limits requests to 32 MiB. Browser sessions receive a secure owner cookie. Native clients, webhooks and public sharing require specific compatibility checks before use. Gateway /healthz only checks the proxy, not application readiness.

Sign into the owner gateway and import an OpenAPI, GraphQL, gRPC or other supported contract. API callers outside Railway add X-Template-Key with ACCESS_PASSWORD; services inside the project may call the private app endpoint.

Scope and limitations

This is explicitly an ephemeral development sandbox. Imports and test state are lost on restart; keep contracts in source control and reimport them.
Asynchronous minions, Kafka, production MongoDB and Keycloak are not provisioned.

Acceptance checks before use

Import a small OpenAPI example and call one generated mock endpoint.
Export or retain the source contract, restart, and confirm the documented reimport workflow.
Confirm generated credentials are distinct on a second fresh deployment.
Back up every listed persistent path and database, then restore into a separate test project.
Measure Railway usage with representative data and workload before estimating operating costs.

Backups and upgrades

Back up databases, file volumes, encryption keys and configuration together. Keep a copy outside the running project. Review upstream migration notes before changing a digest; rollback can require restoring a compatible database and files, not just selecting an older image.

Sources and selection evidence

Upstream documentation: Uber native distribution is a single container on 8080 with an in-memory MongoDB store.
Upstream documentation: Chosen application release.
Upstream project

Product and alias searches found no matching public Railway listing during this research. This is a bounded search result; private, unindexed or differently named listings may exist. It is not evidence of demand or revenue.

Upstream software retains its own license and edition restrictions. This deployment draft does not imply upstream endorsement.