Docs

Quick Start Workflows

Dive straight into practical MockQL workflows and use cases

Common Workflows

Jump into these frequent use cases to get productive quickly

Proxying an Existing REST API

This workflow shows how to proxy an existing API while adding a new endpoint that doesn't exist yet in your backend.

1

Enable Proxy Mode

In your project settings, enable proxy mode and set your base URL as interspector URL in project Setting.

Base URL:

https://api.yourproduct.com
2

Create a New Endpoint

Click "Add Endpoint" and define a path that doesn't exist in your actual API.

Path:

/api/v1/comments

Method:

GET
3

Configure Response

Define the mock response for your new endpoint.

Response Body (JSON)
[
  {
    "id": 1,
    "postId": 101,
    "user": "jane_doe",
    "comment": "This is a great feature!",
    "createdAt": "2023-07-15T14:22:30Z"
  },
  {
    "id": 2,
    "postId": 101,
    "user": "john_smith",
    "comment": "I agree, very useful.",
    "createdAt": "2023-07-15T16:44:12Z"
  }
]
4

Use Your Hybrid API

Point your application to the MockQL URL instead of your original API.

MockQL Proxy URL:

https://mockql.com/api/v1/endpoint/simulate/rest/project-id

Now your application can use:

  • Existing endpoints: Proxied to your real API
  • New /comments endpoint: Served by MockQL
REST API proxy workflow diagram

Visual representation of the REST proxy workflow

Ready for More?

Explore our comprehensive documentation to learn about all the capabilities of MockQL.