Back to Docs

Getting Started

Learn how to set up MockBoost and create your first mock API in minutes.

Quick Start

1. Create Your Account

Visit mockboost.com/register and sign up for a free DEV plan account. You'll get:

  • Unlimited mock endpoints
  • 1,000 API requests per month
  • 30-day log retention

2. Create Your First Workspace

After signing in, you'll be prompted to create your first workspace. A workspace is where you organize your mock APIs and collaborate with your team.

# Navigate to dashboard

Dashboard → Create Workspace

# Enter workspace details

Name: My First Project

3. Create Your First Mock Endpoint

Click the "Create Endpoint" button to set up your first mock API endpoint.

Creating Mock Endpoints

Mock endpoints allow you to simulate real APIs without writing backend code. Here's how to create one:

Step 1: Basic Configuration

  • Endpoint Name: Give your endpoint a descriptive name (e.g., "Users API")
  • HTTP Method: Choose from GET, POST, PUT, PATCH, DELETE
  • Path: Define the URL path (e.g., /api/users)
  • Status Code: Set the HTTP status code (default: 200)

Step 2: Add Mock Data

Define your JSON response data. You can:

  • Write JSON manually
  • Paste existing JSON from your real API
  • Use variables for dynamic responses
{
  "users": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com",
      "role": "developer"
    },
    {
      "id": 2,
      "name": "Jane Smith",
      "email": "jane@example.com",
      "role": "designer"
    }
  ],
  "total": 2,
  "page": 1
}

Step 3: Save and Test

Once saved, MockBoost generates a unique URL for your endpoint:

https://api.mockboost.com/v1/workspaces/your-workspace-id/users

You can immediately start making requests to this URL from your application!

Filtering Mock Data

MockBoost supports powerful filtering capabilities to simulate real database queries:

Query Parameters

Add query parameters to filter your mock data dynamically:

Filter by field:

GET /api/users?role=developer

Pagination:

GET /api/users?page=2&limit=10

Sorting:

GET /api/users?sort=name&order=asc

Advanced Filtering

MockBoost uses PostgreSQL's JSONB indexing with GIN (Generalized Inverted Index) for lightning-fast queries:

  • Search nested JSON structures
  • Filter by multiple criteria
  • Use comparison operators (gt, lt, gte, lte)
  • Perform text search

Managing Endpoints

Editing Endpoints

To modify an existing endpoint:

  1. Navigate to your workspace dashboard
  2. Find the endpoint in the list
  3. Click the edit icon
  4. Update the configuration or data
  5. Save changes

💡 Changes take effect immediately - no deployment required!

Changing Status Codes

Test error handling by changing the HTTP status code:

  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 404 - Not Found
  • 500 - Server Error

Deleting Endpoints

To delete an endpoint permanently:

  1. Click the delete icon on the endpoint card
  2. Confirm the deletion

⚠️ Warning: This action cannot be undone. All associated logs will also be deleted.

Team Collaboration

Inviting Team Members

Team members are managed at account level (Dashboard → Team). Only QA and PROD plans can invite; DEV is single-user.

  1. Go to Dashboard → Team
  2. Click "Invite"
  3. Enter their email and choose which workspace to add them to
  4. Send invite

💡 Invitees receive an email with a secure link to join. You can remove them per workspace from the same Team page.

Roles & Permissions

OWNER

Full control: manage members, billing, delete workspace

ADMIN

Manage endpoints, invite members, view logs

MEMBER

Create and edit endpoints, view logs (read-only access)

Managing Members

From Dashboard → Team you can:

  • View all team members (account-wide)
  • See which workspaces each member belongs to
  • Remove a member from a specific workspace

Next Steps

Now that you understand the basics, explore these advanced topics:

→ API Reference→ Advanced Guides→ Authentication & Security→ Webhooks & Integrations