Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micromata/http-fake-backend
Build a fake backend by providing the content of JSON files or JavaScript objects through configurable routes.
https://github.com/micromata/http-fake-backend
api backend data fake fake-data http http-server json json-files mock mocking mocking-server mocks node nodejs rest rest-api restful restful-api
Last synced: 11 days ago
JSON representation
Build a fake backend by providing the content of JSON files or JavaScript objects through configurable routes.
- Host: GitHub
- URL: https://github.com/micromata/http-fake-backend
- Owner: micromata
- License: mit
- Archived: true
- Created: 2016-03-05T12:25:43.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-10-20T18:05:56.000Z (about 1 year ago)
- Last Synced: 2024-08-01T08:09:20.983Z (3 months ago)
- Topics: api, backend, data, fake, fake-data, http, http-server, json, json-files, mock, mocking, mocking-server, mocks, node, nodejs, rest, rest-api, restful, restful-api
- Language: JavaScript
- Homepage:
- Size: 567 KB
- Stars: 311
- Watchers: 23
- Forks: 22
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs-cn - http-fake-backend - 使用 JSON 文件或者 JavaScript 对象 建立一个伪装的可自定义路由的后端服务 (包 / HTTP)
- awesome-nodejs - http-fake-backend - Build a fake backend by providing the content of JSON files or JavaScript objects through configurable routes.  (Repository / HTTP)
- awesome-nodejs-cn - http-fake-backend - **star:311** 通过可配置路由提供JSON文件或JavaScript对象的内容，构建一个伪后端 ![项目已归档][Archived] (包 / HTTP)
- awesome-nodejs - http-fake-backend - Build a fake backend by providing the content of JSON files or JavaScript objects through configurable routes. (Packages / HTTP)
- awesome-nodejs - http-fake-backend - Build a fake backend by providing the content of JSON files or JavaScript objects through configurable routes. - ★ 171 (HTTP)
- awesome-node - http-fake-backend - Build a fake backend by providing the content of JSON files or JavaScript objects through configurable routes. (Packages / HTTP)
- awesome-nodejs-cn - http-fake-backend - 通过可配置的路线提供JSON文件或JavaScript对象的内容来构建伪造的后端. (目录 / HTTP)
README
[](https://badge.fury.io/gh/micromata%2Fhttp-fake-backend)
[](https://travis-ci.org/micromata/http-fake-backend)
[](https://coveralls.io/github/micromata/http-fake-backend?branch=master)
[](https://david-dm.org/micromata/http-fake-backend)
[](https://david-dm.org/micromata/http-fake-backend#info=devDependencies)
[](https://www.youtube.com/watch?v=qRC4Vk6kisY)
# http-fake-backend
> Build a fake backend by providing the content of JSON files or JavaScript objects through configurable routes.
*It actually can serve the content of other file types as well as sending the files itself as response.*
Comes as a Node.js server. Useful for mocking, testing and developing independent of the »real« backend.
## Sorry, this project is unmaintained 😢
Thanks to all contributors for your work!
We’ve just pushed a last release which fixes some bugs, make this thing run with Node 18.
## Example
Let’s say you need an endpoint like which should return:
```
{
"response": "Yeah"
}
```
It’s a matter of seconds to create this endpoint with help of this little hapi server.
It might take a few seconds longer as setting up the well-made [JSON Server](https://github.com/typicode/json-server) but it’s way more flexible.
## Requirements
- Node.js (18.12.0 or greater)
## Install
```bash
git clone https://github.com/micromata/http-fake-backend.git
npm install
```
Or with help of [Yeoman](http://yeoman.io)
```bash
npm install -g yo
npm install -g generator-http-fake-backend
```
This comes in handy, because the Yeoman generator has a sub-generator to setup endpoints of your fake backend very convenient. See .
## Default Address
The server runs at providing a page with links to all existing API endpoints.
## Start the server
There are the following two options.
### During development
```
npm run start:dev
```
This way the server uses `nodemon` to restart itself on changes.
### Later (eg. for tests in CI)
```
npm start
```
Just starts the server via node.
## Configure endpoints
Each endpoint needs a configuration file in `/server/api/` to define routes, http method and the response.
### Example configurations
#### Simple Example
`/server/api/simpleExample.js`:
```js
module.exports = SetupEndpoint({
name: 'simpleExample',
urls: [{
requests: [
{ response: '/response-files/simpleExample.json' }
]
}]
});
```
#### Advanced Example
`/server/api/anotherExample.js`:
```js
module.exports = SetupEndpoint({
name: 'anotherExample',
urls: [{
params: '/read',
requests: [{
method: 'GET',
response: '/response-files/anotherExample.json'
}]
}, {
params: '/update/{id}',
requests: [{
method: ['PUT', 'PATCH'],
response: {
success: true
}
}, {
method: 'DELETE',
response: {
deleted: true
}
}]
}, ]
});
```
#### Serving different content types
`/server/api/fileTypes.js`:
```js
module.exports = SetupEndpoint({
name: 'fileTypes',
urls: [{
params: '/json',
requests: [{
response: '/response-files/simpleExample.json'
}]
}, {
params: '/text',
requests: [{
response: '/response-files/example.txt',
mimeType: 'text/plain'
}]
}, {
params: '/html',
requests: [{
response: '/response-files/example.html',
mimeType: 'text/html'
}]
}, {
params: '/pdf',
requests: [{
response: '/response-files/example.pdf',
sendFile: true
}]
}]
});
```
#### Faking HTTP errors and status code
`/server/api/fakingStatusCodes.js`:
```js
module.exports = SetupEndpoint({
name: 'statusCodes',
urls: [
{
params: '/boomError',
requests: [{
// Returns a 402 status code + error message provided by boom:
// {
// "error" : "Payment Required",
// "message" : "Payment Required",
// "statusCode" : 402
// }
statusCode: 402
}]
},
{
params: '/customError',
requests: [{
// Returns a HTTP status code 406 and a self defined response:
response: { error: true },
statusCode: 406
}]
},
{
params: '/regularResponse',
requests: [{
// Returns a 401 error provided by boom
// as defined on endpoint level
response: '/response-files/anotherExample.json'
}]
}
],
statusCode: 401
});
```
The configuration object in Detail:
* `name`
* Is used to set the endpoint.
* `urls`
* You need to add at least one url object.
* `urls.params`
* Optional
* URL path parameters with fixed and/or variable path segments.
* Example:
* `params: '/update/{id}'`
* See hapi docs. For example regarding optional [path parameters](http://hapijs.com/api#path-parameters).
* `urls.requests`
* You need to add at least one request object.
* Multiple request objects are needed in case you like to serve different responses via different HTTP methods with the same URL.
* `urls.requests.method`
* optional. Uses `GET` when not defined.
* `string`, or `array` of strings.
* is used to define the http method(s) to which the endpoint will listen.
* `urls.requests.response`
* Could be a string pointing to a file:
* `response: '/response-files/articles.json'`
* Or just a JavaScript object:
* `response: { success: true }`
* `urls.requests.mimeType`
* Optional (string). Defaults to `application/json`.
* Is used to set the `content-type` response header.
* `urls.requests.sendFile`
* Optional (boolean). Defaults to `false`.
* Sends the file as response instead of returning the file content.
* `urls.requests.statusCode`
* Optional (boolean). Defaults to `200`
* The HTTP status code of the response.
* Will return:
* a status code with a self defined response if you provide a response property
* a status code with a predefined error object provided by [boom](https://github.com/hapijs/boom) if you dont provide a response property for that request.
* `statusCode`
* Optional
* Every subroute of this endpoint will return a HTTP error with the given status code provided by [boom](https://github.com/hapijs/boom).
## Configure server
The main config is handled via a file named `.env` with the following content:
```dosini
# NODE_ENV
# Could be either `development` or `production`
NODE_ENV=development
# Port of the Server
SERVER_PORT=8081
# Port for running the tests
TEST_PORT=9090
# URL Prefix for the endpoints
# eg. http://localhost:8081/api/foo
API_PREFIX=/api
# Custom response header
#CUSTOM_HEADER_NAME=Authorization
#CUSTOM_HEADER_VALUE=Bearer eyJhbGciOiJIUzUxMiJ9
```
## Related
* [Yeoman Generator](https://github.com/micromata/generator-http-fake-backend) – Easily generate your fake backend and use sub-generators to setup endpoints like :zap:
## License
Please be aware of the licenses of the components we use in this project.
Everything else that has been developed by the contributions to this project is under [MIT License](LICENSE).