Skip to main content
Mock API Builder
LearnAboutContact
Learning Center/Quick Start Guide
Getting Started5 min tutorial

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
1
Choose Your Starting Path
30 seconds
Start instantly as a guest or create a permanent account

Option 1: Guest Mode (Quick Start)

  1. Click "Create Project" (no login required)
  2. Build and test for 24 hours
  3. Save permanently later by creating an account

Option 2: With Account (Permanent)

  1. Navigate to the registration page
  2. Enter your email and create a password
  3. Build and save projects permanently

Recommendation: Use Guest Mode if you want to explore the features quickly. Create an account if you're ready to start building a real project.

2
Create Your First Project
2 minutes
Use a template to get started instantly

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.

  1. Click "Create New Project" from your dashboard
  2. Scroll to the "Quick Start with Templates" section
  3. Click on the Users API template card
  4. Review the pre-filled data:
    • Project name: "Users"
    • Base URL: "/api/users"
    • Data fields: id, name, email, role, createdAt
    • Mock data count: 10 records
  5. Click "Create Project"

Success! Your project is created with 10 realistic user records automatically generated using Faker.js.

Available Templates

E-commerce API
Products, categories, pricing
Blog API
Posts, authors, comments
Users API
User management, profiles
Task Management
Tasks, status, priorities
Events API
Scheduling, bookings
3
Test Your API
2 minutes
Try out your endpoints with the interactive tester

View Your Project

  1. After creating your project, you'll be redirected to the project detail page
  2. You'll see your endpoint listed (e.g., GET /api/users)
  3. View the sample response data in the preview section

Interactive Testing

Use the built-in API tester to make requests without leaving the browser:

  1. Click the "Test GET" button on your endpoint
  2. A dialog opens with the interactive tester
  3. Click "Send Request"
  4. View the response:
    • Status code (200 OK)
    • Response time in milliseconds
    • Response headers
    • Formatted JSON body with all your mock users

Example Response

json

Test Other Methods

Your endpoint automatically supports all CRUD operations:

  • GET /api/users - Get all users (with pagination)
  • GET /api/users/:id - Get single user
  • POST /api/users - Create new user
  • PUT /api/users/:id - Update user
  • DELETE /api/users/:id - Delete user
4
Add More Endpoints (Optional)
2 minutes
Expand your API with additional endpoints

Adding More Endpoints

Templates are great starting points, but you can easily expand your API with additional resources. Here's how:

  1. Navigate to your project page
  2. Click the "Settings" button in the top-right of the project header
  3. In the Settings dialog, select the "General" tab
  4. Click "Add Endpoint"
  5. Fill in the endpoint details:
    • Path (e.g., "/api/posts", "/api/comments")
    • Description (optional but helpful)
    • Contract format (Manual Fields or JSON)
    • Data structure fields
    • Mock data count
  6. Click "Create Endpoint"

How it works:

When you create an endpoint, the system automatically generates 5 separate HTTP methods for full CRUD functionality:

  • GET /api/posts - List all items
  • POST /api/posts - Create new item
  • GET /api/posts/:id - Get single item
  • PUT /api/posts/:id - Update item
  • DELETE /api/posts/:id - Delete item

Each method is independently configurable and can be deleted if not needed.

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 Resources to Add

  • /api/posts - Blog posts with full CRUD operations
  • /api/comments - User comments (auto-generates 5 methods)
  • /api/categories - Classification/taxonomy data
  • /api/orders - E-commerce order management

Remember: Each path automatically creates collection and item endpoints!

5
Use Your API
1 minute
Integrate with your applications

Copy the Endpoint URL

Your API is instantly accessible at a public URL. Copy it and use it anywhere:

https://www.mockapibuilder.io/api/users

Replace localhost with your deployment URL in production

Use in Your Frontend

Here's how to fetch data in a React component:

javascript

Test with cURL

bash

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?

Learn Core Concepts

Understand projects, endpoints, schemas, and data generation

Read Guide
Import OpenAPI Specs

Import existing API specifications in seconds

Learn How
Real-World Examples

Follow step-by-step tutorials for common use cases

View Examples
Advanced Features

Explore response customization, sharing, and more

Explore Features
Previous: Guest Mode (No Account)Next: Understanding the Dashboard
Mock API Builder

Built for developers, by developers

LearnSupport / ContactPrivacy PolicyTerms of Service

© 2026 Mock API Builder. All rights reserved.

Learning Center
← Back to Dashboard
Learning Center
← Back to Dashboard