FAPI

A developer tool for creating and simulating Fake APIs (FAPIs) in seconds.

Document Version: v1.0.1 Document Last Updated: February 15, 2026

What is FAPI?

FAPI (Fake API) is a lightweight, zero-configuration developer tool that allows you to create and simulate fake/ mock API endpoints locally. It enables developers to work independently without waiting for real APIs to be ready. FAPI lets you quickly simulate different API responses and behaviors in just a few clicks, without making any changes to the actual API or database — all while keeping your data 100% local and private.

[!IMPORTANT]

FAPI is 100% Local & Private. FAPI data never leaves your machine unless you explicitly choose to export and share it.

Table of Contents

• What is FAPI?
• NPM Package
• Use Cases FAPI Addresses
• Key Features
• Installation & Usage
• Running Multiple FAPI Instances
• How It Works
• Examples
  • Basic Endpoint Creation
  • Complete Workflow Example
  • Successful Response Examples
  • Error Response Examples
  • Using FAPI Endpoints in Your Frontend Code
  • Use FAPI with Any Service
• Requirements
• Contributing
• License

NPM Package

FAPI is available as an npm package for easy installation and usage.

• Package Name: start-fapi
• Registry: https://www.npmjs.com/package/start-fapi
• Installation: No installation required - use directly with npx start-fapi
• Node.js Requirement: >= 20.9.0
• Repository: https://github.com/sohamderoy/FAPI-Fake-APIs

Use Cases FAPI Addresses

• Any Service Needing Mock APIs: Whether you're building a frontend app, backend service, mobile application, or any system that consumes APIs—FAPI can simulate the endpoints you need
• Parallel Development: Enable frontend and backend teams to work simultaneously with agreed-upon API contracts
• Rapid API Response Prototyping: Experiment with API response structures before actual implementation
• Error & Edge Case Testing: Test error handling and edge cases handling by simulating various API failure scenarios, status codes, responses and response delays
• Load Testing UI: Test how your frontend handles slow APIs by adding realistic network delays
• Third-party API Simulation: Mock external APIs (payment gateways, social media APIs) to avoid costs and rate limits during development
• Demo Applications: Quickly create working UI prototypes and demos without production backend dependencies
• Learning & Education: Developers learning frontend development can practice API integration without setting up complex backends
• Offline Development: Work on projects during travel or in environments without internet connectivity

Key Features

• Quick Setup: Build custom API endpoints instantly through an intuitive UI
• Zero Configuration: File-based storage with no database required
• 100% Local & Private: All data stays on your machine, works completely offline
• Persistent Storage: All endpoints and configurations are automatically saved and persist across browser sessions and server restarts
• Customizable Responses: Configure custom HTTP status codes (200, 404, 500 etc) and JSON responses (support for other formats coming soon)
• Realistic Simulation: Add custom response delays to simulate network latency
• Flexible HTTP Methods: Support for GET, POST, PUT, DELETE requests (support for other methods coming soon)
• Full Endpoint Control: Create, edit, and delete endpoints on the fly
• Multiple Instances: Run FAPI on different ports with completely isolated data for each instance
• Import/Export: Share API configurations with your team or back up your endpoints as JSON files
• Project Names: Organize and identify different FAPI instances with custom project names
• Developer-Friendly: Interactive UI for seamless endpoint management

Installation & Usage

Prerequisites: Node.js (v20.9.0 or higher) must be installed. Download Node.js

Run FAPI directly with npx:

npx start-fapi
# Starts FAPI on default port 3000

Running Multiple FAPI Instances

You can run multiple instances of FAPI on different ports to support multiple projects. Each instance maintains completely isolated and independent data - endpoints, configurations, and responses created in one instance will not affect or appear in another instance:

# Terminal 1: Starts FAPI on default port 3000 to support project A
npx start-fapi

# Terminal 2: Starts FAPI on port 3001 to support project B
npx start-fapi --port 3001

# Terminal 3: Starts FAPI on port 5501 to support project C
npx start-fapi --port 5501

How It Works

1. Run the command npx start-fapi
2. Open your browser at http://localhost:3000
3. Create fake API endpoints through the UI
4. Your endpoints are immediately available at http://localhost:3000/api/fapi/<your-endpoint-name>

Examples

Basic Endpoint Creation

If you create an endpoint named /users, it will be accessible at:

http://localhost:3000/api/fapi/users

Complete Workflow Example

Let's create a simple user management API:

Successful Response Examples

1. Get All Users (GET)

Create an endpoint:

• Endpoint Path: /users
• HTTP Method: GET
• Response:

{
  "users": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com"
    },
    {
      "id": 2,
      "name": "Jane Smith",
      "email": "jane@example.com"
    }
  ]
}

• Status Code: 200
• Delay: 2000ms (optional - simulates network latency)

2. Get Single User (GET)

Create an endpoint:

• Endpoint Path: /users/1
• HTTP Method: GET
• Response:

{
  "id": 1,
  "name": "John Doe",
  "email": "john@example.com",
  "role": "admin"
}

• Status Code: 200

3. Create User (POST)

Create an endpoint:

• Endpoint Path: /users
• HTTP Method: POST
• Response:

{
  "message": "User created successfully",
  "user": {
    "id": 3,
    "name": "New User",
    "email": "newuser@example.com"
  }
}

• Status Code: 200

4. Update User (PUT)

Create an endpoint:

• Endpoint Path: /users/1
• HTTP Method: PUT
• Response:

{
  "message": "User updated successfully",
  "user": {
    "id": 1,
    "name": "John Doe Updated",
    "email": "john.updated@example.com"
  }
}

• Status Code: 200

5. Delete User (DELETE)

Create an endpoint:

• Endpoint Path: /users/1
• HTTP Method: DELETE
• Response:

{
  "message": "User deleted successfully"
}

• Status Code: 200

Error Response Examples

1. 500 Internal Server Error

Create an endpoint:

• Endpoint Path: /users/999
• HTTP Method: GET
• Response:

{
  "error": "Internal Server Error"
}

• Status Code: 500
• Delay: 5000ms (simulate slow failing request - to test how UI behaves while waiting for API response)

Using FAPI Endpoints in Your Frontend Code

Once you've created endpoints, call the API via Postman or similar application or use them like any standard API:

// Get all users
fetch("http://localhost:3000/api/fapi/users")
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error:", error));

// Create a new user
fetch("http://localhost:3000/api/fapi/users", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Alice Johnson",
    email: "alice@example.com",
  }),
})
  .then((response) => response.json())
  .then((data) => console.log(data));

// Update a user
fetch("http://localhost:3000/api/fapi/users/1", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "John Doe Updated",
    email: "john.updated@example.com",
  }),
})
  .then((response) => response.json())
  .then((data) => console.log(data));

// Delete a user
fetch("http://localhost:3000/api/fapi/users/1", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data));

Use with any HTTP client: fetch, axios, React Query, etc.

Use FAPI with Any Service

FAPI endpoints are standard HTTP endpoints that work with any service or tool that can make HTTP requests.

Command Line

# Using curl
curl http://localhost:3000/api/fapi/users

# Using httpie
http GET http://localhost:3000/api/fapi/users

Backend Services

Any backend service (Node.js, Python, Go, Java, etc.) can call FAPI endpoints just like any other API.

API Testing Tools

Works with Postman, Insomnia, Thunder Client, or any API testing tool.

Mobile Apps

iOS, Android, or cross-platform apps (React Native, Flutter) can use FAPI during development.

Requirements

• Node.js >= 20.9.0

Contributing

This project is open for contributions and your efforts will be highly appreciated.

For details please see:

• CONTRIBUTING.md - Contribution guidelines, development setup, and PR process
• RELEASE_PROCESS.md - Release strategy, versioning, and branching model

License

MIT