json-mockify is a lightweight Node.js server that serves JSON data from files, allowing for easy mocking of API responses during development and testing. It can be used as a standalone server or integrated into your existing Node.js frontend or backend projects.

---

• Serve JSON data from files as API responses.
• Supports CRUD (Create, Read, Update, Delete) operations.
• Configurable via a simple JSON configuration file.
• Easy setup and usage.

---

Clone the repository:

git clone https://github.com/ritheesh4/json-mockify.git

Install dependencies:

npm install

---

1. Define your JSON data files in the data directory(db.json or any file name).
2. Configure your server settings in the config.json file.
3. Create the mock server file(mock-server.js or any file name).
4. Start the server:

npm start

---

The config.json file allows you to customize various server settings:

• hostname: The hostname for the server (default: "localhost").
• port: The port number for the server (default: 3000).
• dbFilePath: The path to the JSON data file to serve. Example config.json:

{ "port": 3000, "dbFilePath": "./db.json" }

• Make sure that db path should be in the level of library. If you are creating a folder for this mock api, make user the db path as nested.

We have to create server.js file and need to add this configuration.

//server.js
const path = require('path');
const createServer = require('json-mockify');

// Provide the name of the custom configuration file
const customConfigFilename = 'defaultConfig.json';

// Resolve the absolute path to the custom configuration file
const customConfigPath = path.resolve(__dirname, customConfigFilename);

// Create server with custom configuration
createServer(customConfigPath);

Once the above file created, you can directly run the file using command below.

node server.js

---

API Endpoints

• GET /path/to/resource: Retrieve data from the specified path.
• POST /path/to/resource: Create a new resource.
• DELETE /path/to/resource/: Delete a resource by ID.
• Query based GET requests
• Query based POST requests

Examples: To retrieve data from a JSON file named data/db.json, make a GET request to /. For example:

http://localhost:3000/

---

Contributions are welcome! If you have suggestions, feature requests, or bug reports, please open an issue or create a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.