Fake API docs

Introduction

Fake API helps you quickly create mock APIs for developing and testing applications without needing a real backend. It's useful when you want to develop the frontend independently, test different scenarios (success, error, delay), demo an app with simulated data, or quickly experiment with an idea without setting up a server.

Each project you create gets a unique public projectId. You attach this to a path and define the JSON body, HTTP status code, and delay for each endpoint. The final URL format is:

https://www.fake-api.dev/{projectId}{your_created_path}

Getting started: account & login

You need an account before you can create projects and endpoints.

You need to verify your email before you can use all features.

Create a project

After logging in, you'll land on the Project management page, this is where all your mock APIs are organized.

The project list shows each project's Name and its public_id, that's the projectId you'll use in mock API URLs.

Endpoint groups

Endpoint groups help you organize endpoints by functionality or module, for example users, orders, or products. On desktop, groups appear in the left panel of the project page, on mobile, use the dropdown menu instead. Select a group to view and configure its endpoints.

• Create: click Create new in the Endpoint Group section, enter a name, and Save.
• Edit or delete: use the ⋮ menu on a group to rename it, or delete it along with all endpoints inside.

Create endpoints

Endpoints define how the mock API responds when it's called. Select an Endpoint Group, click Create new, and fill in:

Example endpoint configuration:

{
  "method": "GET",
  "path": "/api/users/1",
  "response_body": {
    "id": 1,
    "name": "John Doe",
    "email": "johndoe@example.com"
  },
  "delay_ms": 500,
  "status_code": 200
}

Click Save, the endpoint list updates right away with the new endpoint.

Dynamic routes

Prefix a path segment with : to turn it into a dynamic parameter that matches any value, for example /api/users/:id. That single endpoint responds to /api/users/1, /api/users/42, and any other value in that position, so you don't need a separate endpoint per id.

If both a literal path and a dynamic path could match the same request, the literal (exact) match always wins, the dynamic route is only used as a fallback when no exact match is found.

Edit, delete, and copy URL

• Edit: click an endpoint to open the edit form, change the method, path, body, delay, or status, then Save.
• Delete: use the trash icon on an endpoint, or Delete all to clear every endpoint in the group.
• Copy URL: click the copy icon to copy the full https://www.fake-api.dev/{projectId}{path} URL, ready to paste into your code.

Call the mock API

Use the projectId shown in the API Endpoint card on your project's detail page:

curl -X GET https://www.fake-api.dev/QGONEwKEqJg/api/user/1

fetch('https://www.fake-api.dev/QGONEwKEqJg/api/users/1')
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

axios.get('https://www.fake-api.dev/QGONEwKEqJg/api/users/1')
  .then(response => console.log(response.data))
  .catch(error => console.error('Error:', error));

When you call the API, it will:

1. Find the endpoint matching the method and path
2. Apply the configured delay_ms, if any
3. Return the response_body with the configured status_code

Tips for using Fake API

• Follow RESTful naming: plural resources (/api/users), details (/api/users/123), sub-resources (/api/users/123/orders).
• Group related endpoints into the same Endpoint Group so they're easy to find and manage.
• Keep response JSON concise, only include fields you actually need, with realistic sample data.
• Create multiple endpoints for different data states, e.g. an active user and an inactive user.