https://github.com/requestly/requestly-mock-server
Requestly Mock Server
https://github.com/requestly/requestly-mock-server
Last synced: 6 months ago
JSON representation
Requestly Mock Server
- Host: GitHub
- URL: https://github.com/requestly/requestly-mock-server
- Owner: requestly
- License: agpl-3.0
- Created: 2022-12-08T09:14:46.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-06-05T04:52:01.000Z (8 months ago)
- Last Synced: 2025-07-22T14:03:01.208Z (7 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@requestly/mock-server
- Size: 258 KB
- Stars: 12
- Watchers: 11
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# requestly-mock-server
This Repo contains the core express server [@requestly/mock-server](https://www.npmjs.com/package/@requestly/mock-server) package which powers Requestly's Cloud Mock Server.
## Development
### Install Dependencies
``` sh
npm i
```
### Start Server
``` sh
npm start:dev
```
## Usage with firebase-functions
### Install
``` sh
npm i @requestly/mock-server
```
### Setup
``` javascript
import * as functions from 'firebase-functions';
import { MockServer } from '@requestly/mock-server';
import firebaseConfig from '../firebaseConfig';
const startMockServer = () => {
const expressApp = new MockServer(3000, firebaseConfig, '/api/mockv2').app;
return functions.runWith({ minInstances: isProdEnv() ? 1 : 0 }).https.onRequest(expressApp);
};
export const handleMockRequest = startMockServer();
```
``` javascript
class FirebaseConfig implements IConfig {
getMockSelectorMap = (kwargs?: any) => {
/**
* Fetch and return mockSelectorMap from firestore
* {
* mockId: {
* route: "",
* method: "",
* }
* }
*/
};
getMock = (id: string, kwargs?: any) => {
/**
* Fetch mock details from firestore
*/
}
storeLog? = (log: Log) => {
/**
* Store log in cloud storages
*/
}
}
const firebaseConfig = new FirebaseConfig();
export default firebaseConfig;
```
## Requestly Cloud Mock Server Architechture
**STEPS**
1. Request coming from GET `https://username.requestly.dev/users`
2. Firebase Function passes the request to @requestly/mock-server
3. @requestly/mock-server - MockSelector
a. Fetches all the available mocks using `IConfig.getMockSelectorMap()` (Firestore in case of Requestly)
b. Select mock if any endpoint+method matches the incoming request (GET /users)
c. Fetch Mock using `IConfig.getMock(mockId)` and pass it to MockProcessor
4. @requestly/mock-server - MockProcessor
a. Process Mock - Response Rendering
b. Return Response