Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/centeredge/runtime-mock-routes
Define mock http service routes and responses at runtime
https://github.com/centeredge/runtime-mock-routes
Last synced: 9 days ago
JSON representation
Define mock http service routes and responses at runtime
- Host: GitHub
- URL: https://github.com/centeredge/runtime-mock-routes
- Owner: CenterEdge
- License: mit
- Created: 2020-09-11T21:12:15.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-09T20:50:14.000Z (almost 2 years ago)
- Last Synced: 2024-09-16T08:51:23.187Z (2 months ago)
- Language: TypeScript
- Size: 208 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Runtime-Mock-Routes
Runtime-Mock-Routes is a nodejs application for defining parameterized route and response bodies. This is ideal for mocking 3rd party services.
## Installation
Use the package manager [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to install Runtime-Mock-Routes.
```bash
npm install -g @centeredgesoft/runtime-mock-routes
```
## Usage
```bash
runtime-mock-routes -p 8080 -s ./seed.json
```
All command line options are optional. If a seed file is supplied, it must be one of the following
* a json file that matches a `RuntimeRequestCollection`
* a js file with a default export of type `RuntimeRequestCollection`
* a js file with a default export of a function that returns a `RuntimeRequestCollection`
```typescript
type SupportedMethodsType = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];
const SupportedMethodsColection: SupportedMethodsType = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];
type SupportedMethod = SupportedMethodsType[number];
export interface RuntimeRequestMethodBody {
body: any;
status?: any;
headers?: Record;
}
export type RuntimeRequestMethodBodyCollection = Partial>;
export interface RuntimeRequestBody {
path: string;
methods: RuntimeRequestMethodBodyCollection;
}
export interface RuntimeRequestCollection {
[path: string]: RuntimeRequestBody;
}
```
For example:
```JSON
{
"/test":{
"path":"/test",
"methods":{
"GET": {
"body": {},
"status": 200,
"headers": {
"X-Custom-Header": "yes"
}
}
}
}
}
```
The following environment variables can also be used in place of command line options
```
RUNTIME_MOCK_ROUTES_PORT=8080
RUNTIME_MOCK_ROUTES_FILE_PATH=/seed.json
```
Route parameters are specified in path via a colon followed by the parameter name.
`'/users/:id'`
Template strings that are compatible with [handlebars](https://handlebarsjs.com/) can be used for the `body` property of a `RuntimeRequestMethodBody`. The application will use path and query params as data for the tempalte. This application makes use of [faker](https://www.npmjs.com/package/faker) and [chance](https://www.npmjs.com/package/chance) as Handlebars Helpers.
```
{{params.}} {{query.}}
{{body.}}
{{headers.}}
{{ faker "lorem.words" 5}} {{ chance "guid"}}
```
If the rendered template is valid JSON, the response will be of type `application/json`.
Also, be aware that instead of a direct JSON response, the body can also be a function that takes in a `RequestParameters` and returns a body response. The response will still be processed through handlebars.
### Routes
* `GET /` returns all of the currently defined routes
* `POST /` Takes a `RuntimeRequestBody` and adds it to the collection or updates the existing entry if it exists.
* `PUT /` Takes a `RuntimeRequestCollection` and replaces the current collection.
* `[GET,POST,PUT,PATCH,DELETE] /*` The result of retrieving an entry in the collection, 404 otherwise
* `DELETE /?path=` Deletes items from the collection
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to add/update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)