API Status: Offline
Documentation

Tooling

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

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.

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).