JSON Server Docker Project

A ready-to-use mock REST API server built with JSON Server and Docker, perfect for frontend development, testing, and prototyping.

Features

• 🐳 Docker containerized for easy deployment
• 📁 Sample database with realistic data structures
• 🔄 Auto-reload when data changes
• 🔍 Full CRUD operations with filtering, sorting, pagination
• 🤝 Relationship support (_embed, _expand)
• 📚 Postman collection for easy testing

Quick Start

Prerequisites

• Docker installed (Install Docker)

Running the Server

# Clone the repository
git clone https://github.com/anandhuk/json-server-docker.git
cd json-server-docker

# Build and run the container
docker build -t json-server .
docker run -p 3000:3000 -v $(pwd)/db.json:/usr/src/app/db.json json-server

Your API will be available at http://localhost:3000

API Endpoints

Basic CRUD Endpoints

Advanced Features

Filtering

GET /users?address.city=New York
GET /products?price_gte=50&price_lte=100

Pagination

GET /products?_page=1&_limit=2
GET /users?_start=1&_end=3

Sorting

GET /products?_sort=price&_order=desc
GET /users?_sort=name&_order=asc

Full-text Search

GET /posts?q=react

Relationships

GET /posts/1?_embed=comments
GET /orders/1?_expand=user

Postman Collection

A complete Postman collection is included in the repository (Postman-collection.json).

Features:

All CRUD operations for each resource

Example requests with sample payloads

Environment variables for easy configuration

Test scripts for basic validation

To import:

Open Postman

Click "Import" > Select the collection file

Set the base_url variable to http://localhost:3000

• TODO: Authentication endpoints will be added in future updates

Deployment Options

1. Local Development

docker run -p 3000:3000 -v $(pwd)/db.json:/usr/src/app/db.json json-server

2. Production (with Docker Compose)

docker-compose up -d

3. Cloud Deployment

This container can be deployed to any cloud platform that supports Docker:

AWS ECS

Google Cloud Run

Azure Container Instances

Heroku with Docker support

License

Distributed under the MIT License. See LICENSE for more information.