Quick Start
Let's get you from "zero" to your first mocked API in under 5 minutes.
1. Choose Your Entry Point
Mockzilla offers two ways to interact with your API traffic.
docker run -d -p 36666:36666 andrecrjr/mockzilla
2. Your First Mock in 3 Steps
Step 1 Create a Folder
Folders are how you group related endpoints. Click New Folder on the dashboard and name it my-api.
Step 2 Add an Endpoint
Inside your folder, click Create Mock:
- Path:
/hello - Response:
{"message": "Welcome to Mockzilla!"} - Status:
200 OK
Step 3 Call It
Every folder has a "Serve URL" prefix. Open this in your browser:
http://localhost:36666/api/mock/my-api/hello
Or use cURL:
curl http://localhost:36666/api/mock/my-api/hello
🤖 AI-First: Agent Instructions
While manual creation is great for a single endpoint, Mockzilla is designed to be AI-First. If you have an existing OpenAPI spec or a JSON sample, let an AI agent bootstrap your entire API in seconds via MCP.
"Use mockzilla-mock-maker to create a folder called my-api and add a GET endpoint /hello that returns a JSON message: 'Welcome to Mockzilla!'"
// Tip: You can also say "Refactor this mock to use a realistic JSON Schema."
Next Steps
Now that you've served a basic mock, it's time to see the true power of Mockzilla.
Want your mocks to "remember" actions? Check out the Stateful Workflows tutorial.
