# mockhttpkit > Instant mock REST API from your Zod schemas: full CRUD routes, realistic fake data and request validation in one command. Latest version **1.0.1** (published 2026-09-27) · MIT license · 0 weekly downloads ## Install ```sh npm install mockhttpkit pnpm add mockhttpkit yarn add mockhttpkit bun add mockhttpkit ``` Provides the command `mockhttpkit`. ## Health **Score 70/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2026-09-27 | | First published | 2026-09-27 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=18.17 | | Dependencies | 5 | | Unpacked size | 287.2 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | Author | PLACEHOLDER-NAME | | Maintainers | devnolan | | Keywords | mock api, mock server, zod, fake data, rest mock, local dev server, faker, crud, api mocking, prototyping | ## Links - npm: https://www.npmjs.com/package/mockhttpkit - npm.io page: https://npm.io/package/mockhttpkit ## Dependencies (5) - [zod](https://npm.io/package/zod.md) ^3.24.1 - [jiti](https://npm.io/package/jiti.md) ^2.4.2 - [express](https://npm.io/package/express.md) ^4.21.2 - [commander](https://npm.io/package/commander.md) ^12.1.0 - [@faker-js/faker](https://npm.io/package/@faker-js/faker.md) ^9.3.0 ## Alternatives - [pagerjs](https://npm.io/package/pagerjs.md) — 60 weekly downloads - [whistle.savefor-mock](https://npm.io/package/whistle.savefor-mock.md) — 4 weekly downloads - [@newmo/eslint-plugin-graphql-fake](https://npm.io/package/@newmo/eslint-plugin-graphql-fake.md) — 0 weekly downloads - [steamspy-mcp](https://npm.io/package/steamspy-mcp.md) — 0 weekly downloads - [cool-one](https://npm.io/package/cool-one.md) — 0 weekly downloads ## Recent versions - 1.0.1 (latest) — 2026-09-27 - 1.0.0 — 2026-09-27 ## README # mockhttpkit **Turn your Zod schemas into a working mock REST API, with CRUD routes, realistic fake data and request validation, in one command.** ```bash npm install --save-dev mockhttpkit zod npx mockhttpkit start --schema ./schema.ts ``` The npm package is `mockhttpkit`; the command it installs is `mockhttpkit`. Requires Node.js 18.17 or newer. --- ## Quick start **1. Install** into your project (or an empty folder): ```bash npm install --save-dev mockhttpkit zod ``` **2. Write a schema file.** Every exported `z.object()` becomes a REST resource. ```ts // schema.ts import { z } from 'zod'; export const UserSchema = z.object({ id: z.number().int(), name: z.string(), email: z.string().email(), role: z.enum(['admin', 'member']), }); export const PostSchema = z.object({ id: z.number().int(), userId: z.number().int(), title: z.string(), published: z.boolean(), }); ``` **3. Start the server:** ```bash npx mockhttpkit start --schema ./schema.ts ``` ``` mockhttpkit running at http://localhost:4000 /posts 10 items (PostSchema) /users 10 items (UserSchema) 12 routes · GET http://localhost:4000/ for the full list · Ctrl+C to stop ``` **4. Call it.** Paste these into a second terminal. On Windows, use Git Bash or `curl.exe`; in Windows PowerShell 5, plain `curl` is an alias for a different command. Fetch one record (the fake values will differ each run): ```bash curl http://localhost:4000/users/1 ``` ```json {"id":1,"name":"Ms. Joyce Dooley MD","email":"marcelle_corwin-stanton@gmail.com","role":"admin"} ``` Filter and limit a list: ```bash curl "http://localhost:4000/users?role=admin&_limit=2" ``` ```json [{"id":1,"name":"Ms. Joyce Dooley MD","email":"marcelle_corwin-stanton@gmail.com","role":"admin"},{"id":2,"name":"Lowell Heller Sr.","email":"mercedes12@yahoo.com","role":"admin"}] ``` Create a record. It's validated against `UserSchema` and gets the next id: ```bash curl -X POST http://localhost:4000/users \ -H "Content-Type: application/json" \ -d '{"name":"Ada Lovelace","email":"ada@example.com","role":"admin"}' ``` ```json {"id":11,"name":"Ada Lovelace","email":"ada@example.com","role":"admin"} ``` Send invalid data and you get your schema's own error messages back: ```bash curl -X POST http://localhost:4000/users \ -H "Content-Type: application/json" \ -d '{"name":"Bad","email":"not-an-email","role":"owner"}' ``` ```json {"error":"Validation failed","issues":[{"path":"email","message":"Invalid email address"},{"path":"role","message":"Invalid option: expected one of \"admin\"|\"member\""}]} ``` Update part of a record, then delete it: ```bash curl -X PATCH http://localhost:4000/users/11 -H "Content-Type: application/json" -d '{"role":"member"}' # {"id":11,"name":"Ada Lovelace","email":"ada@example.com","role":"member"} curl -X DELETE http://localhost:4000/users/11 # (204 No Content) curl http://localhost:4000/users/11 # {"error":"users with id 11 not found"} ``` Validation messages are worded by your Zod version; the examples above are from Zod 4. ## Why mockhttpkit The frontend is ready to build, but the API it needs doesn't exist yet. The usual workarounds are hard-coded JSON files, or a hand-written mock server that drifts out of date. If you already describe your data with Zod, you've written everything a mock needs. mockhttpkit reads those schemas and serves a realistic, validating API from them, so the frontend work isn't blocked on the backend. ## CLI reference ``` mockhttpkit start --schema [options] ``` | Flag | Default | Description | | --- | --- | --- | | `-s, --schema ` | *(required)* | `.ts` or `.js` file exporting Zod schemas. TypeScript is compiled on the fly, with no build step. | | `-p, --port ` | `4000` | Port to listen on. `0` picks a free port. | | `--host ` | `localhost` | Interface to bind. `localhost` listens on both `127.0.0.1` and `::1`. | | `-c, --count ` | `10` | Fake records generated per resource (max 100000). | | `-d, --delay ` | `0` | Latency added to every response, to test loading states. | `mockhttpkit --help` and `mockhttpkit start --help` print the same reference. ## Routes Each exported `z.object()` becomes a resource. The name has any trailing `Schema` removed, is converted to kebab-case, and is pluralised: `UserSchema` → `/users`, `BlogPost` → `/blog-posts`, `Person` → `/people`. | Method | Path | Behaviour | | --- | --- | --- | | `GET` | `/users` | List. `?field=value` filters (repeat a field for OR), `?_limit=`, `?_offset=`. Total count in the `X-Total-Count` header. | | `GET` | `/users/:id` | One record, or `404` | | `POST` | `/users` | Create. Validated by Zod; returns `201`, or `400` with the issues | | `PUT` | `/users/:id` | Replace (validated) | | `PATCH` | `/users/:id` | Merge into the existing record, then validate | | `DELETE` | `/users/:id` | Remove; returns `204` | `GET /` lists every resource and route. CORS is open, so a dev server on another port can call mockhttpkit directly. Data lives in memory for the current run. Stop the server and it starts fresh next time. ## Using schemas from multiple files `--schema` points at a single file, but that file doesn't have to define your schemas directly — it can just re-export them from wherever they already live in your project: ```ts // mock-schema.ts export * from './src/models/user'; export * from './src/models/order'; export * from './src/models/product'; ``` ```bash npx mockhttpkit start --schema ./mock-schema.ts ``` Every exported `z.object()` across all the re-exported files becomes its own resource, exactly as if they were defined in one file. This means mockhttpkit works the same way on a small project or a large one with schemas spread across many files — you just point it at one small file that gathers them. ## How the fake data is chosen 1. **By field name.** `email`, `name`, `firstName`, `avatar`, `phone`, `city`, `price`, `createdAt`, `userId`, `isActive` and about 60 more map to fitting [faker](https://fakerjs.dev) generators. Matching ignores case and separators. 2. **By Zod type and constraints.** mockhttpkit respects: - string checks: `.email()`, `.url()`, `.uuid()`, `.datetime()`, `.min()` / `.max()` / `.length()`, `.startsWith()`; - number checks: `.int()`, `.positive()`, `.multipleOf()`, and date ranges; - enums, literals, nested objects, arrays, records, unions, and optional or nullable fields. 3. **Numeric `id`s count up from 1.** Other ids are UUIDs, or are generated from the id's own schema. Every generated record is checked against your schema. If a rule can't be satisfied automatically, such as a custom `.refine()` or a `.regex()`, mockhttpkit prints a one-line warning naming the field. ## Compatibility Because mockhttpkit adheres strictly to standard HTTP/1.1 and RFC 8259 JSON specifications with standard status codes and CORS headers, any language or HTTP client works out of the box without special adapters. | Language | GET list | GET one | POST | PATCH | DELETE | all pass | | --- |:---:|:---:|:---:|:---:|:---:|:---:| | JavaScript (native fetch) | PASS | PASS | PASS | PASS | PASS | PASS | | Python (urllib stdlib) | PASS | PASS | PASS | PASS | PASS | PASS | | Go (net/http stdlib) | PASS | PASS | PASS | PASS | PASS | PASS | | Java (java.net.http stdlib) | PASS | PASS | PASS | PASS | PASS | PASS | | PHP (curl stdlib) | PASS | PASS | PASS | PASS | PASS | PASS | | Ruby (net/http stdlib) | PASS | PASS | PASS | PASS | PASS | PASS | | curl (bash baseline) | PASS | PASS | PASS | PASS | PASS | PASS | ## Feature requests Found a bug or want a feature added? Email [devnolan.co@gmail.com](mailto:devnolan.co@gmail.com) describing what you need. Upcoming features are planned around what people ask for. ## License [MIT](LICENSE) --- _Source: https://npm.io/package/mockhttpkit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._