Projects

Configure Mock API Projects | Mock API Studio

Create a Mock API Studio project, choose its stable slug and local port, organize its models and resources, and synchronize it to the local runtime.

Create a project

Give the project a descriptive name and stable slug. The slug identifies the project in CLI commands and names its local SQLite file.

Shell
npx mock-api-studio-cli start customer-portal

Choose project settings

Configure the default local port, record seed, record count, query parameter names, latency, failure rate, and optional authentication to match the frontend contract.

Add models and resources

Define reusable TypeScript models, then bind exported response types to resource paths and enabled operations.

Synchronize changes

Save a valid configuration and restart the CLI. Preserve local records before accepting regeneration after a material schema or configuration change.

Related questions

Can two projects use the same local port at once?

No. Give concurrent runtimes different ports or pass a one-time --port override.

Keep exploring

Last updated September 17, 2026. Product behavior described here is verified against the current Mock API Studio runtime.