API Documentation - Rest Faker

Rest Faker

API Documentation

API Status: Offline

Quick Start Guide

Get started with Rest Faker in minutes. Create your data model, generate your API, and start making requests.

Custom Data Models

Create your own data structures with custom fields and types

Instant API Generation

Get a working REST API endpoint immediately after creation

Relations

Define belongsTo, hasMany, and hasOne relations between your data models

Flexible Sorting

Sort by any field in ascending or descending order

How It Works

Create Your Project

Set up a new project (e.g., "Blog") with a descriptive name

Design Your Data Model

Use our Route Creator to define fields like "title", "description", "slug", etc.

Configure Field Types

Select data types (lorem, words, paragraphs) and customize fake data generation

Get Your API

Instantly receive a working REST API endpoint with your custom data

Basic Usage

javascript

// Basic GET request
fetch('https://api.restfaker.dev/api/schema/posts', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));

Mock Authentication System

When you enable the Mock Auth toggle in your project settings, Rest Faker automatically provides a complete authentication system with signup, signin, and profile management endpoints.

What You Get

User Registration

Secure Login

JWT-based authentication system

Profile Management

View user profiles

Authentication Endpoints

User Registration

POST /api/schema/signup

Request Body:

firstName: string (required)
lastName: string (required)
email: string (required)
password: string (required)

Example Request:

javascript

// Sign up a new user
fetch('https://api.restfaker.dev/api/schema/signup', {
  method: 'POST',
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: 'user@example.com',
    password: 'securePassword123',
    firstName: 'John',
    lastName: 'Doe'
  })
})
.then(response => response.json())
.then(data => console.log(data));

Response:

json

{
  "success": true,
  "message": "User created successfully",
  "data": {
    "id": "uuid-string",
    "email": "user@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "projectId": "uuid-string",
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2025-01-15T10:30:00Z",
  }
}

User Login

POST /api/schema/signin

Authenticate an existing user and receive a JWT token for accessing protected routes.

Request Body:

email: string (required)
password: string (required)

Example Request:

javascript

// Sign in an existing user
fetch('https://api.restfaker.dev/api/schema/signin', {
  method: 'POST',
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: 'user@example.com',
    password: 'securePassword123'
  })
})
.then(response => response.json())
.then(data => {
  // Store the auth token for future requests
  const authToken = data.token;
  console.log(data);
});

Response:

json

{
  "success": true,
  "message": "Login successful",
  "token": "jwt-token-string"
}

Profile Management

GET /api/schema/profile

View user profile information. Requires authentication token in the Authorization header.

Get Profile:

javascript

// Get user profile (requires auth token)
fetch('https://api.restfaker.dev/api/schema/profile', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Authorization': 'Bearer jwt-token-here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));

Profile Response:

json

{
  "success": true,
  "data": {
    "id": "uuid-string",
    "email": "user@example.com",
    "projectId": "uuid-string",
    "firstName": "John",
    "lastName": "Doe",
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2025-01-15T10:30:00Z",
  }
}

Important Notes

This is a mock authentication system designed for development and testing purposes only.

User data is generated with fake information and may be reset periodically.

JWT tokens are valid for testing but should not be used in production applications.

All auth endpoints require your project's API token in addition to user authentication.

Getting Started with Mock Auth

Enable Mock Auth

Toggle the "Mock Auth" switch in your project settings to activate the authentication system.

Test User Registration

Use the signup endpoint to create test users with fake email addresses.

Implement Frontend Auth

Store JWT tokens and include them in headers for protected API calls.

API Endpoints

Your custom endpoints are generated based on your route configuration. Rest Faker provides full CRUD operations for every route you create.

Base URL

https://api.restfaker.dev

CRUD Endpoints

Where {route} is the name you defined in the Route Creator (e.g., "posts", "users", "products").

GET /api/schema/{route}List all records (paginated)

GET /api/schema/{route}/:idGet a single record

POST /api/schema/{route}Create a new record

PATCH /api/schema/{route}/:idUpdate an existing record

DELETE /api/schema/{route}/:idDelete a record

Auto-Generated Fields

Every record automatically includes the following system fields, regardless of your schema definition:

idUUID v4 - unique identifier for each record

createdAtISO 8601 datetime - set when the record is created

updatedAtISO 8601 datetime - updated on every modification

userIdUUID - added only when Mock Auth is enabled and route is protected

Get Single Record

javascript

// Get a single post by ID
fetch('https://api.restfaker.dev/api/schema/posts/d9c03940-8451-4c3e-944f-6ddfd23390f6', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));

// Response:
// {
//   "id": "d9c03940-8451-4c3e-944f-6ddfd23390f6",
//   "title": "Lorem ipsum dolor sit amet",
//   "description": "Consectetur adipiscing elit...",
//   "createdAt": "2025-01-15T10:30:00Z",
//   "updatedAt": "2025-01-15T10:30:00Z"
// }

Create Record

javascript

// Create a new post
// NOTE: the request body must be wrapped in a "data" key
fetch('https://api.restfaker.dev/api/schema/posts', {
  method: 'POST',
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      title: 'My New Post',
      description: 'This is the post content.',
      slug: 'my-new-post'
    }
  })
})
.then(response => response.json())
.then(data => console.log(data));

// Response:
// {
//   "id": "a1b2c3d4-...",
//   "title": "My New Post",
//   "description": "This is the post content.",
//   "slug": "my-new-post",
//   "createdAt": "2025-01-15T12:00:00Z",
//   "updatedAt": "2025-01-15T12:00:00Z"
// }

Update Record

javascript

// Update an existing post
fetch('https://api.restfaker.dev/api/schema/posts/d9c03940-8451-4c3e-944f-6ddfd23390f6', {
  method: 'PATCH',
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Updated Post Title'
  })
})
.then(response => response.json())
.then(data => console.log(data));

// Response:
// {
//   "id": "d9c03940-8451-4c3e-944f-6ddfd23390f6",
//   "title": "Updated Post Title",
//   "description": "Original description...",
//   "slug": "lorem-ipsum-dolor-sit-amet",
//   "createdAt": "2025-01-15T10:30:00Z",
//   "updatedAt": "2025-01-15T14:00:00Z"
// }

Delete Record

javascript

// Delete a post
fetch('https://api.restfaker.dev/api/schema/posts/d9c03940-8451-4c3e-944f-6ddfd23390f6', {
  method: 'DELETE',
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));

// Response:
// {
//   "success": true,
//   "message": "Record deleted successfully"
// }

Query Parameters

The list endpoint (GET /api/schema/{route}) supports the following query parameters:

Pagination

page - Page number (default: 1)

perPage - Items per page (default: 10, max: 100)

Sorting

sort - Field name to sort by

order - Sort direction (asc, desc)

Response FormatPremium

format - Response format. Pass xml to receive XML instead of JSON. Requires a paid plan.

javascript

// Request XML instead of JSON
fetch('https://api.restfaker.dev/api/schema/posts?format=xml', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.text())
.then(xml => console.log(xml));

// XML Response:
// <?xml version="1.0" encoding="UTF-8"?>
// <response>
//   <data>
//     <item>
//       <id>d9c03940-8451-4c3e-944f-6ddfd23390f6</id>
//       <title>Lorem ipsum dolor sit amet</title>
//       <createdAt>2025-01-15T10:30:00Z</createdAt>
//     </item>
//   </data>
//   <meta>
//     <total>50</total>
//     <page>1</page>
//     <perPage>10</perPage>
//     <pages>5</pages>
//   </meta>
// </response>

Route Creator Example

Route Name:posts

Field Configuration:

title

lorem - paragraph

description

lorem - words

slug

lorem - word

Relations

Rest Faker supports defining relationships between your data models. Relations determine how records from different routes are linked and how nested data is returned in API responses.

belongsTo

A record belongs to another record. Adds a foreign key field (e.g., postId) to the child model.

hasMany

A record has many related records. Returns a nested array of related items in the response.

hasOne

A record has exactly one related record. Returns a nested object in the response.

belongsTo

Use belongsTo when a record references a parent record. For example, a Comment belongs to a Post. This adds a foreign key field to the child record.

json

// A "comments" route configured with belongsTo "posts"
// Each comment record will include a postId field

// GET /api/schema/comments
{
  "data": [
    {
      "id": "c1a2b3c4-...",
      "body": "Great article!",
      "postId": "d9c03940-8451-4c3e-944f-6ddfd23390f6",
      "createdAt": "2025-01-15T11:00:00Z",
      "updatedAt": "2025-01-15T11:00:00Z"
    }
  ],
  "meta": { "total": 25, "page": 1, "perPage": 10, "pages": 3 }
}

hasMany

Use hasMany when a record owns multiple related records. For example, a Post has many Comments. The related records are returned as a nested array.

json

// A "posts" route configured with hasMany "comments"
// Each post record will include a nested comments array

// GET /api/schema/posts/d9c03940-8451-4c3e-944f-6ddfd23390f6
{
  "id": "d9c03940-8451-4c3e-944f-6ddfd23390f6",
  "title": "Lorem ipsum dolor sit amet",
  "description": "Consectetur adipiscing elit...",
  "comments": [
    {
      "id": "c1a2b3c4-...",
      "body": "Great article!",
      "postId": "d9c03940-8451-4c3e-944f-6ddfd23390f6",
      "createdAt": "2025-01-15T11:00:00Z",
      "updatedAt": "2025-01-15T11:00:00Z"
    },
    {
      "id": "e5f6a7b8-...",
      "body": "Thanks for sharing.",
      "postId": "d9c03940-8451-4c3e-944f-6ddfd23390f6",
      "createdAt": "2025-01-15T12:00:00Z",
      "updatedAt": "2025-01-15T12:00:00Z"
    }
  ],
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}

hasOne

Use hasOne when a record has exactly one related record. For example, a User has one Profile. The related record is returned as a nested object.

json

// A "users" route configured with hasOne "profile"
// Each user record will include a nested profile object

// GET /api/schema/users/a1b2c3d4-...
{
  "id": "a1b2c3d4-...",
  "firstName": "John",
  "lastName": "Doe",
  "profile": {
    "id": "p1q2r3s4-...",
    "bio": "Software developer and writer",
    "avatar": "https://example.com/avatar.jpg",
    "userId": "a1b2c3d4-...",
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2025-01-15T10:30:00Z"
  },
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}

Configuring Relations

Relations are configured in the Route Creator when defining your data model. Select the relation type and the target route to establish the link. The foreign key fields and nested data are handled automatically by Rest Faker.

Scenario Engine

The Scenario Engine lets you simulate real-world API conditions on a per-route basis. Configure latency, error injection, and rate limiting to test how your frontend handles adverse conditions.

Latency Simulation

Add configurable delay to responses with min/max milliseconds to simulate slow networks.

Error Injection

Return errors at a configurable rate (0-100%) with custom status codes and messages.

Rate Limiting

Limit the number of requests allowed per time window to simulate API throttling.

Latency Simulation

When latency is configured for a route, each request is delayed by a random duration between the min and max values. This is useful for testing loading states and timeouts.

minMinimum delay in milliseconds

maxMaximum delay in milliseconds

javascript

// With latency configured (min: 500ms, max: 2000ms),
// each request is delayed by a random amount in that range.

// Request behaves normally but takes 500-2000ms to respond:
fetch('https://api.restfaker.dev/api/schema/posts', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));  // Response arrives after delay

Error Injection

When error injection is configured, a percentage of requests will return the specified error status code and message instead of the normal response.

ratePercentage of requests that return errors (0-100)

statusCodeHTTP status code to return (e.g., 500, 503, 429)

messageCustom error message included in the response body

json

// With error injection configured (rate: 50%, statusCode: 500,
// message: "Internal Server Error"), ~50% of requests will fail:

// Successful response (50% of requests):
{
  "data": [...],
  "meta": { "total": 50, "page": 1, "perPage": 10, "pages": 5 }
}

// Error response (50% of requests):
// HTTP 500
{
  "error": "Internal Server Error"
}

Rate Limiting

When rate limiting is configured, requests that exceed the allowed threshold within the time window are rejected with a 429 status code.

maxRequestsMaximum number of requests allowed per window

windowMsTime window duration in milliseconds

json

// With rate limiting configured (maxRequests: 10, windowMs: 60000),
// after 10 requests within 60 seconds you'll receive:

// HTTP 429
{
  "error": "Too Many Requests",
  "message": "Rate limit exceeded. Try again later."
}

Configuring Scenarios

Scenarios are configured per-route in your project dashboard. You can enable multiple scenario types on the same route. For example, you can combine latency simulation with error injection to test how your app handles slow, unreliable APIs.

Tooling

Rest Faker provides tools to speed up integration — import existing API specs, download ready-to-use Postman collections, and get TypeScript types for your schemas.

OpenAPI ImportPremium

Import an existing OpenAPI 3.x or Swagger 2.x spec to auto-create a project with all routes already configured.

Postman Collection

Download a pre-configured Postman collection for your entire project — all routes, auth headers, and example requests included.

TypeScript Types

Download a .ts file with TypeScript interfaces generated from your schemas. Paste directly into your frontend project.

OpenAPI / Swagger ImportPremium

If you already have an OpenAPI specification, you can import it directly to generate a complete Rest Faker project without manually defining each route.

Supported formats:

OpenAPI 3.x

JSON or YAML

Swagger 2.x

JSON or YAML

How to import:

Open the Import dialog

From your project list, click the Import OpenAPI button.

Paste or upload your spec

Paste the spec text directly, or upload a .json, .yaml, or .yml file.

Preview & select routes

Rest Faker parses the spec and shows every detected route with its mapped fields. Deselect any routes you don't need.

Confirm import

Give the project a name and click Import. A new project is created with all selected routes ready to use.

Field mapping: Rest Faker automatically maps spec field types (e.g. format: email) and common field names (e.g. firstName, price, avatar) to the appropriate Faker.js generators. Fields that cannot be mapped are flagged as unmapped in the preview.

Download Postman Collection

Export your entire project as a Postman collection (.json). The collection includes every route with pre-filled headers, example request bodies, and the correct API token, so you can start testing immediately after import.

What's included:

All CRUD endpoints for every route in the project

Pre-configured apiToken header

Mock Auth endpoints (signup, signin, profile) when authentication is enabled

Example request bodies for POST and PATCH requests

How to download: Open your project in the dashboard and click Download Collection. Import the resulting .json file into Postman via File → Import.

Download TypeScript Types

Generate a .ts file containing TypeScript interfaces for every schema in your project. Drop it into your frontend codebase for instant type safety.

typescript

// Example generated types file (types.ts)

export interface Post {
  id: string;
  title: string;
  description: string;
  slug: string;
  createdAt: string;
  updatedAt: string;
}

export interface Comment {
  id: string;
  body: string;
  postId: string;   // added because of belongsTo relation
  createdAt: string;
  updatedAt: string;
}

export interface ApiResponse<T> {
  data: T[];
  meta: {
    total: number;
    page: number;
    perPage: number;
    pages: number;
  };
}

How to download: Open your project in the dashboard and click Download Types. The file is named after your project (e.g. my-blog-types.ts).

Code Examples

Practical examples showing how to use your generated API endpoints.

Pagination

javascript

// Pagination example
fetch('https://api.restfaker.dev/api/schema/posts?page=2&perPage=10', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));

Sorting

javascript

// Sorting by fields
fetch('https://api.restfaker.dev/api/schema/posts?sort=createdAt&order=desc', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));

cURL Example

bash

# cURL example
curl -X GET "https://api.restfaker.dev/api/schema/posts" \
  -H "apiToken: your_api_token_here" \
  -H "Content-Type: application/json"

Response Format

json

{
  "data": [
    {
      "id": "d9c03940-8451-4c3e-944f-6ddfd23390f6",
      "title": "Lorem ipsum dolor sit amet",
      "description": "Consectetur adipiscing elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
      "slug": "lorem-ipsum-dolor-sit-amet",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 50,
    "page": 1,
    "perPage": 10,
    "pages": 5
  }
}

Advanced Usage

Combining multiple query parameters:

javascript

// Advanced sorting and pagination
fetch('https://api.restfaker.dev/api/schema/posts?page=2&perPage=5&sort=createdAt&order=desc', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => {
  console.log(`Found ${data.meta.total} posts`);
  console.log(`Showing page ${data.meta.page} of ${data.meta.pages}`);
  data.data.forEach(post => {
    console.log(`- ${post.title}`);
  });
});

Need Help?

Check out our support documentation or contact our team for assistance.

Quick Start Guide

Custom Data Models

Instant API Generation

Relations

Flexible Sorting

How It Works

Create Your Project

Design Your Data Model

Configure Field Types

Get Your API

Basic Usage

Authentication

API Token

Getting Your API Token

Mock Authentication System

What You Get

User Registration

Secure Login

Profile Management

Authentication Endpoints

User Registration

Request Body:

Example Request:

Response:

User Login

Request Body:

Example Request:

Response:

Profile Management

Get Profile:

Profile Response:

Important Notes

Getting Started with Mock Auth

Enable Mock Auth

Test User Registration

Implement Frontend Auth

API Endpoints

Base URL

CRUD Endpoints

Auto-Generated Fields

Get Single Record

Create Record

Update Record

Delete Record

Query Parameters

Pagination

Sorting

Response FormatPremium

Route Creator Example

Relations

belongsTo

hasMany

hasOne

belongsTo

hasMany

hasOne

Configuring Relations

Scenario Engine

Latency Simulation

Error Injection

Rate Limiting

Latency Simulation

Error Injection

Rate Limiting

Configuring Scenarios

Tooling

OpenAPI ImportPremium

Postman Collection

TypeScript Types

OpenAPI / Swagger ImportPremium

Supported formats:

How to import:

Open the Import dialog

Paste or upload your spec

Preview & select routes

Confirm import

Download Postman Collection

What's included:

Download TypeScript Types

Code Examples