typicode/json-server
Json Server
json-server is a development toolset used to simulate a full REST API from a JSON file. It functions as a customizable mock API server that allows for the simulation of CRUD operations and resource relationships without the need to write backend code.
The project enables rapid prototyping by generating a fake backend that persists data changes back to a local JSON file. It distinguishes itself by providing a static asset file server to deliver local documents, images, and stylesheets alongside the mock API endpoints.
The server includes capabilities for data querying, such as parameter-based filtering, pagination, and sorting. It also supports resource relationship management through relational data embedding and offers extensibility via a middleware-based request pipeline for custom logic and authentication.
Features
- Dynamic REST API Generators - Generates a full RESTful API dynamically from a local JSON file to simulate a backend.
- API Mocking Servers - Functions as a local mocking server that simulates CRUD operations and complex query filtering.
- JSON-Based Persistence - Persists application data as structured JSON files on the local filesystem.
- Data Query Filters - Implements field-based criteria and logical operators for narrowing down data sets via API requests.
- Query Parameter Filters - Transforms URL query parameters into filters, sorts, and pagination logic for data retrieval.
- Relational Resource Mapping - Allows fetching related data by embedding child resources or expanding parent references in a single request.
- Data Mocking - Simulates API responses and resource relationships using static JSON data files.
- Mock State Management - Performs standard CRUD operations on collection arrays and singular object resources via HTTP methods.
- Relational Data Embedding - Resolves links between different JSON collections by embedding child objects or expanding parent references.
- Query Filters - Supports range-based constraints, slicing, and sorting to retrieve specific subsets of data.
- Automatic Endpoint Mapping - Maps URL paths to JSON arrays based on the keys found in the source file to create automatic endpoints.
- Local Development Servers - Provides a lightweight local server to manage stateful CRUD operations and resource relationships.
- API Mocking - Provides a tool for simulating API responses to facilitate frontend development without a live backend.
- Mocking Tools - Generates a full mock REST API directly from a JSON file.
- Pagination - Splits large data collections into smaller, manageable pages using page and per-page parameters.
- API Route Customization - Provides configuration options to map custom URL paths to specific JSON resources.
- Middleware-Based Request Pipelines - Processes incoming HTTP requests through a modular chain of pluggable functions for custom logic.
- Rapid Prototyping - Enables a rapid prototyping workflow by simulating server responses to iterate on features quickly.
- Custom Middleware Implementations - Supports custom middleware and request handlers for authentication, validation, and response behaviors.
- Frontend Integration Testing - Simulates a predictable local data source to test how frontend applications handle various API responses.
- API Debugging and Mocking - Creates fake REST APIs with zero coding.
- Developer Tools - Mock REST API generator for rapid prototyping.
- HTTP Clients - Instant mock REST API from JSON files.
- Testing and Debugging - Tool for serving REST APIs from static JSON files.
- Testing Frameworks - Zero-code REST API mock server.
- 模拟数据( Mock ) - Listed in the “模拟数据( Mock )” section of the Awesome Frontend awesome list.
- Node.js - Listed in the “Node.js 项目” section of the Great Open Source Project awesome list.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
