Mock Server

A RESTful mock server built with json-server for rapid API prototyping and testing.

npm install

npm start

This starts the server on http://localhost:3000 with live reload when db.json changes.

npm run start:custom

This runs the custom server with additional middleware and routes.

npm run dev

This adds a 1-second delay to all responses to simulate real network conditions.

The server provides the following REST endpoints:

• GET /api/users - Get all users
• GET /api/users/:id - Get user by ID
• POST /api/users - Create a new user
• PUT /api/users/:id - Update user
• DELETE /api/users/:id - Delete user

• GET /api/posts - Get all posts
• GET /api/posts/:id - Get post by ID
• POST /api/posts - Create a new post
• PUT /api/posts/:id - Update post
• DELETE /api/posts/:id - Delete post

• GET /api/comments - Get all comments
• GET /api/comments/:id - Get comment by ID
• POST /api/comments - Create a new comment
• PUT /api/comments/:id - Update comment
• DELETE /api/comments/:id - Delete comment

• GET /api/products - Get all products
• GET /api/products/:id - Get product by ID
• POST /api/products - Create a new product
• PUT /api/products/:id - Update product
• DELETE /api/products/:id - Delete product

• GET /api/health - Health check endpoint
• GET /api/search?q=query - Search endpoint (placeholder)

json-server supports various query parameters for filtering, sorting, and pagination:

GET /api/users?role=developer
GET /api/posts?authorId=1
GET /api/products?inStock=true

GET /api/users?_sort=name&_order=asc
GET /api/posts?_sort=createdAt&_order=desc

GET /api/users?_page=1&_limit=10

GET /api/users?q=john

GET /api/posts?_expand=user
GET /api/users?_embed=posts

The server comes with sample data including:

• Users: Developer profiles with roles and contact info
• Posts: Blog posts with authors and timestamps
• Comments: Post comments with relationships
• Products: E-commerce product catalog

1. Edit db.json to add new data collections
2. The endpoints will be automatically available

Edit server.js to add custom routes and middleware:

// Add custom routes
server.get('/api/custom-endpoint', (req, res) => {
  res.json({ message: 'Custom response' });
});

To reset the database to its original state:

npm run reset

This will restore db.json from the backup file.

• PORT - Server port (default: 3000)

You can test the API using curl, Postman, or any HTTP client:

# Get all users
curl http://localhost:3000/api/users

# Get a specific user
curl http://localhost:3000/api/users/1

# Create a new user
curl -X POST http://localhost:3000/api/users \
  -H "Content-Type: application/json" \
  -d '{"name":"New User","email":"new@example.com","role":"tester"}'

# Update a user
curl -X PUT http://localhost:3000/api/users/1 \
  -H "Content-Type: application/json" \
  -d '{"name":"Updated Name","email":"updated@example.com","role":"senior-developer"}'

# Delete a user
curl -X DELETE http://localhost:3000/api/users/1

• ✅ Full REST API with CRUD operations
• ✅ Automatic route generation from JSON data
• ✅ Filtering, sorting, and pagination
• ✅ Full-text search
• ✅ Relationships and data expansion
• ✅ CORS support
• ✅ Custom middleware support
• ✅ Hot reload during development
• ✅ Database backup and reset functionality

Feel free to submit issues and enhancement requests!

MIT