mockapi-instant-rest-api-from-json

MockAPI

Create a REST API from a JSON file. Perfect for frontend development, testing, prototyping.

Installation

npm install -g @lxgicstudios/mockapi

Quick Start

# Create example db.json
npx @lxgicstudios/mockapi --init

# Start server
npx @lxgicstudios/mockapi db.json

Data File Format

Create db.json:

{
  "users": [
    { "id": 1, "name": "Alice", "email": "alice@example.com" },
    { "id": 2, "name": "Bob", "email": "bob@example.com" }
  ],
  "posts": [
    { "id": 1, "title": "Hello", "body": "Content", "userId": 1 }
  ]
}

Generated Routes

For each resource (users, posts):

Method	Route	Description
GET	/users	List all
GET	/users/:id	Get by id
POST	/users	Create
PUT	/users/:id	Replace
PATCH	/users/:id	Update
DELETE	/users/:id	Delete

Query Parameters

# Filter
GET /users?name=Alice

# Pagination
GET /users?_page=1&_limit=10

# Sort
GET /users?_sort=name&_order=asc

Options

Option	Description
-p, --port	Port (default: 3001)
-d, --delay	Response delay in ms
-w, --watch	Watch file for changes
-r, --readonly	Disable mutations
--init	Create example db.json

Common Use Cases

Frontend development:

npx @lxgicstudios/mockapi db.json --watch

Demo with delay:

npx @lxgicstudios/mockapi db.json --delay 500

Read-only API:

npx @lxgicstudios/mockapi db.json --readonly

Features

• Full CRUD operations
• Automatic ID generation
• Filtering and pagination
• Sorting
• CORS enabled
• Hot reload with --watch
• Persistent changes to JSON

---

Built by LXGIC Studios

🔗 GitHub · Twitter