Gathering detailed insights and metrics for mock-mate
Installations
npm install mock-mateDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
20.16.0
NPM Version
10.8.3
Releases
Unable to fetch releases
Contributors
1
Download Statistics
Total Downloads
255
Last Day
1
Last Week
18
Last Month
38
Last Year
255
Maintainers
1
Package Meta Information
Latest Version
1.1.1
Package Id
mock-mate@1.1.1
Unpacked Size
879.92 kB
Size
292.21 kB
File Count
4
NPM Version
10.8.3
Node Version
20.16.0
Publised On
10 Sept 2024
Total Downloads
Cumulative downloads
Total Downloads
255
Last day
-66.7%
1
Compared to previous day
Last week
100%
18
Compared to previous week
Last month
1,800%
38
Compared to previous month
Last year
0%
255
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
Mock Mate
Mock Mate is a powerful and flexible API mocking tool that generates API mocks from OpenAPI specifications (supports both YAML and JSON formats). It allows developers to easily simulate API endpoints for testing and development purposes. With built-in customization options, users can update mock responses dynamically based on request properties such as the request body.
Features
- Automatic API Mock Generation: Automatically generate API mocks from OpenAPI specs (YAML/JSON).
- Supports Multiple Formats: Works with both YAML and JSON OpenAPI specs.
- Dynamic Response Updates: Customize API responses on the fly via an update endpoint.
- Conditional Response Matching: Define rules to send specific responses based on request body values.
- Flexible and Extensible: Easily mock any endpoint and customize default responses for your tests.
- Ideal for Development and Testing: Simulate real API behavior in local environments or CI pipelines.
Installation
To install Mock Mate, first clone the repository or add it as a dependency in your project.
Using npm
1npm install mock-mate
Usage
1. Add an OpenAPI Spec
Mock Mate can use either YAML or JSON OpenAPI specs to generate mocks. Place your OpenAPI spec file in your project.
Example OpenAPI spec (YAML):
1openapi: 3.0.0 2info: 3 title: Mock Mate API 4 version: 1.0.0 5paths: 6 /Consent: 7 post: 8 summary: Create a consent 9 responses: 10 '200': 11 description: Consent created 12 content: 13 application/json: 14 example: 15 ver: '2.0.0' 16 txnid: '123456789' 17 timestamp: '2023-06-26T11:39:57.153Z' 18 ConsentHandle: '654024c8-29c8-11e8-8868-0289437bf331' 19 '400': 20 description: Bad Request 21 content: 22 application/json: 23 example: 24 code: 400 25 msg: 'Bad Request'
2. Initialize and Start Mock Mate
In your project, you can use the getMockMate function to load the OpenAPI spec file and initialize the mock server.
1import { getMockMate } from 'mock-mate'; 2 3// Path to your OpenAPI spec file 4const filePath = './path-to-your-openapi-spec.yaml'; 5 6// Initialize the Mock Mate instance 7const mockMate = getMockMate(filePath); 8 9// Start the mock server 10mockMate.start();
This will start the mock server with the API paths and endpoints defined in the OpenAPI spec.
3. Dynamic Response Matching
You can update mock responses dynamically, including the ability to define conditions based on the request body. When a request matches the defined conditions, the corresponding response will be returned.
For example, to return a 409 Conflict when the txnid field in the request body equals "conflict-id":
1mockMate.updateMockConfig( 2 '/Consent', 3 'post', 4 409, 5 { code: 409, msg: 'Conflict: Consent already exists' }, 6 [{ field: 'txnid', value: 'conflict-id' }] 7);
In this case, when a POST /Consent request has { "txnid": "conflict-id" } in the request body, a 409 Conflict response will be sent.
4. Example cURL for Updating Mock Responses
You can dynamically update mock responses by sending a request to /mock/update. Here’s an example:
1curl -X POST http://localhost:3000/mock/update -H "Content-Type: application/json" -d '{ 2 "path": "/Consent", 3 "method": "POST", 4 "statusCode": 409, 5 "responseBody": { 6 "code": 409, 7 "msg": "Conflict: Consent already exists" 8 }, 9 "conditions": [ 10 { 11 "field": "txnid", 12 "value": "conflict-id" 13 } 14 ] 15}'
This will ensure that a POST /Consent request with "txnid": "conflict-id" in the request body will return a 409 Conflict response.
5. Docker Support
Mock Mate also includes Docker support for easy deployment in testing environments. You can build the Docker image and run the mock server as a container.
1. Build the Docker Image
1docker build -t mock-mate:latest .
2. Run the Docker Container
1docker run -d -p 3000:3000 mock-mate:latest
The mock server will now be available on http://localhost:3000.
Contributing
Contributions are welcome! Please open an issue or submit a pull request if you'd like to contribute to Mock Mate.
License
This project is licensed under the MIT License. See the LICENSE file for details.
About Us
This tool is developed and maintained by S25Digital.
No vulnerabilities found.
No security vulnerabilities found.