MockAPI - Instant REST API from JSON
Spin up a mock REST API server from JSON files in seconds. Full CRUD, filtering, pagination. Zero config. Free CLI tool for frontend developers.
What this skill does
# MockAPI
Create a REST API from a JSON file. Perfect for frontend development, testing, prototyping.
## Installation
```bash
npm install -g @lxgicstudios/mockapi
```
## Quick Start
```bash
# Create example db.json
npx @lxgicstudios/mockapi --init
# Start server
npx @lxgicstudios/mockapi db.json
```
## Data File Format
Create `db.json`:
```json
{
"users": [
{ "id": 1, "name": "Alice", "email": "[email protected]" },
{ "id": 2, "name": "Bob", "email": "[email protected]" }
],
"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
```bash
# 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:**
```bash
npx @lxgicstudios/mockapi db.json --watch
```
**Demo with delay:**
```bash
npx @lxgicstudios/mockapi db.json --delay 500
```
**Read-only API:**
```bash
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](https://lxgicstudios.com)**
๐ [GitHub](https://github.com/lxgicstudios/mockapi) ยท [Twitter](https://x.com/lxgicstudios)
Related in Web Dev
generating-lwc-components
IncludedLightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc/**/*.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use generating-apex), Aura components, or Visualforce.
tanstack-query
IncludedManage server state in React with TanStack Query v5. Set up queries with useQuery, mutations with useMutation, configure QueryClient caching strategies, implement optimistic updates, and handle infinite scroll with useInfiniteQuery. Use when: setting up data fetching in React projects, migrating from v4 to v5, or fixing object syntax required errors, query callbacks removed issues, cacheTime renamed to gcTime, isPending vs isLoading confusion, keepPreviousData removed problems.
document-processor-api
IncludedProcess documents with Nutrient DWS. Use when the user wants to generate PDFs from HTML or URLs, convert Office/images/PDFs, assemble or split packets, OCR scans, extract text/tables/key-value pairs, redact PII, watermark, sign, fill forms, optimize PDFs, or produce compliance outputs like PDF/A or PDF/UA. Triggers include convert to PDF, merge these PDFs, OCR this scan, extract tables, redact PII, sign this PDF, make this PDF/A, or linearize for web delivery.
nutrient-document-processing
IncludedProcess documents with Nutrient DWS. Use when the user wants to generate PDFs from HTML or URLs, convert Office/images/PDFs, assemble or split packets, OCR scans, extract text/tables/key-value pairs, redact PII, watermark, sign, fill forms, optimize PDFs, or produce compliance outputs like PDF/A or PDF/UA. Triggers include convert to PDF, merge these PDFs, OCR this scan, extract tables, redact PII, sign this PDF, make this PDF/A, or linearize for web delivery.
tanstack-query
IncludedManage server state in React with TanStack Query v5. Covers useMutationState, simplified optimistic updates, throwOnError, network mode (offline/PWA), and infiniteQueryOptions. Use when setting up data fetching, fixing v4โv5 migration errors (object syntax, gcTime, isPending, keepPreviousData), or debugging SSR/hydration issues with streaming server components.
accelint-nextjs-best-practices
IncludedNext.js performance optimization and best practices. Use when writing Next.js code (App Router or Pages Router); implementing Server Components, Server Actions, or API routes; optimizing RSC serialization, data fetching, or server-side rendering; reviewing Next.js code for performance issues; fixing authentication in Server Actions; or implementing Suspense boundaries, parallel data fetching, or request deduplication.