Quick Start Guide
Create, test, and deploy your first mock API in just 5 minutes. No backend knowledge required!
What You'll Learn
- How to create your first account
- How to create a project using templates
- How to test your API endpoints
- How to use your API in external applications
Create Your Account
- Navigate to the registration page
- Enter your email address
- Create a strong password (minimum 8 characters)
- Optionally add your name for personalization
- Click "Sign Up"
💡 Pro Tip: Your password is securely hashed with bcrypt and your data is protected with industry-standard security measures.
Login
Already have an account? Go to the login page and enter your credentials. You'll receive a JWT token that's valid for 7 days.
Using a Template
The fastest way to get started is with one of our pre-built templates. We'll use the Users API template as an example.
- Click "Create New Project" from your dashboard
- Scroll to the "Quick Start with Templates" section
- Click on the 👥 Users API template card
- Review the pre-filled data:
- Project name: "Users"
- Base URL: "/api/users"
- Data fields: id, name, email, role, createdAt
- Mock data count: 10 records
- Click "Create Project"
Success! Your project is created with 10 realistic user records automatically generated using Faker.js.
Available Templates
View Your Project
- After creating your project, you'll be redirected to the project detail page
- You'll see your endpoint listed (e.g.,
GET /api/users) - View the sample response data in the preview section
Interactive Testing
Use the built-in API tester to make requests without leaving the browser:
- Click the "Test GET" button on your endpoint
- A dialog opens with the interactive tester
- Click "Send Request"
- View the response:
- Status code (200 OK)
- Response time in milliseconds
- Response headers
- Formatted JSON body with all your mock users
Example Response
Test Other Methods
Your endpoint automatically supports all CRUD operations:
GET /api/users- Get all users (with pagination)GET /api/users/:id- Get single userPOST /api/users- Create new userPUT /api/users/:id- Update userDELETE /api/users/:id- Delete user
Adding Missing Endpoints
Templates are great starting points, but you might need additional endpoints. For example, you might want to add individual resource endpoints (e.g., "Get User by ID"). Here's how:
- Navigate to your project page
- Click the "Settings" button in the top-right
- In the Settings dialog, select the "General" tab
- Click "Add Endpoint"
- Fill in the endpoint details:
- Endpoint name (e.g., "user-details", "posts")
- Description (optional but helpful)
- Contract format (Manual Fields or JSON)
- Data structure fields
- Mock data count
- Click "Create Endpoint"
Pro Tip: You can add as many endpoints as you need. Each endpoint can have its own data structure and mock data, making it perfect for testing complex APIs.
Common Endpoints to Add
- • Individual resource by ID (e.g., /posts/:id, /users/:id)
- • Related resources (e.g., /posts/:id/comments)
- • Search or filter endpoints (e.g., /search, /posts/filter)
- • Authentication endpoints (e.g., /auth/login, /auth/register)
Copy the Endpoint URL
Your API is instantly accessible at a public URL. Copy it and use it anywhere:
http://localhost:3000/api/usersReplace localhost with your deployment URL in production
Use in Your Frontend
Here's how to fetch data in a React component:
Test with cURL
🎉 Congratulations!
You've successfully created your first mock API! You can now:
- Create more projects with different templates
- Customize response data, delays, and status codes
- Import existing OpenAPI/Swagger specifications
- Share projects with your team
- Generate professional API documentation
What's Next?
Understand projects, endpoints, schemas, and data generation
Read GuideImport existing API specifications in seconds
Learn HowFollow step-by-step tutorials for common use cases
View ExamplesExplore response customization, sharing, and more
Explore Features