Toggle navigation
Documentation
Mock API Studio Documentation
Learn how to define TypeScript schemas, generate mock data, configure REST behavior, and run Mock API Studio as a persistent local mock server. Start with the guided setup, then use each focused reference page as your project gains behavior.
01
Getting started
Create a project, add a typed resource, synchronize the CLI, and call your first endpoint.
02
Architecture
Read the focused Mock API Studio documentation.
03
Projects
Read the focused Mock API Studio documentation.
04
Resources
Read the focused Mock API Studio documentation.
05
TypeScript schema
Use supported TypeScript declarations and bind exported response types to resources.
06
Shared types
Read the focused Mock API Studio documentation.
07
Data generation
Generate seeded, realistic records from model shapes and semantic field names.
08
Relationships
Connect parent and child resources while preserving valid foreign keys.
09
Pagination, filtering, and sorting
Match planned query names, pagination limits, search, and safe sorting.
10
Authentication
Exercise bearer-token, API-key, and Basic authentication flows.
11
Runtime settings
Read the focused Mock API Studio documentation.
12
Errors and latency
Add fixed delay and probabilistic service failures to local responses.
13
Local runtime
Understand what runs locally, SQLite persistence, and cloud synchronization.
14
Realtime endpoints
Read the focused Mock API Studio documentation.
15
CLI reference
Install the CLI, start projects, select workspaces, and manage local tokens.
16
Complete example
Read the focused Mock API Studio documentation.
17
Endpoint reference
Choose paths, response shapes, and the CRUD operations exposed locally.
18
OpenAPI
Inspect the generated OpenAPI 3 document and bundled Swagger UI.
19
Troubleshooting
Resolve common token, port, schema, query, and relationship problems.