https://github.com/ccnokes/bogus-api
Mock API server for front-end development. Based on json-server and allows for multiple resources, short-circuiting responses, and a proxy server fallback.
https://github.com/ccnokes/bogus-api
Last synced: about 2 months ago
JSON representation
Mock API server for front-end development. Based on json-server and allows for multiple resources, short-circuiting responses, and a proxy server fallback.
- Host: GitHub
- URL: https://github.com/ccnokes/bogus-api
- Owner: ccnokes
- Created: 2015-11-25T05:12:12.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-02-09T15:51:37.000Z (over 10 years ago)
- Last Synced: 2025-03-12T07:29:54.887Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bogus API
A wrapper around the great [json-server](https://github.com/typicode/json-server). It allows you to specify multiple REST resources. Pass in a directory of Javascript files to be required, and they become your REST endpoints.
### Install
```
npm install bogus-api
```
### Usage
```javascript
require('bogus-api').create({
resourceDir: './my-resources',
resourceUriPrefix: '/api/v1',
}).start();
```
Each JS file in the `my-resources` directory could look like:
```javascript
var users = [];
// Create 10 users
for (var i = 0; i < 10; i++) {
users.push({ id: i, name: 'user' + i });
}
module.exports = users;
```
Or it could look like:
```javascript
module.exports = [
{ "id": 1, "title": "json-server", "author": "typicode" },
{ "id": 2, "title": "test", "author": "ccnokes" }
];
```
So you get a little more flexibility than with plain `json-server`.
You can add or override routes using the Express API like so:
```javascript
bogusAPI = require('bogus-api');
var bogusServer = bogusAPI.create({
// These routes will get mounted before the resources are, allowing you to "short-circuit" them
// This is useful for testing how the UI reacts to error states from an API
priorityRoutes: function(server) {
// the server arg is an instance of an Express server
server.get('/someRoute', function(req, res) {
res.status(500).send({ message: 'Some error.' });
});
}
}).start();
```
## Options
| Option | Description |
| ----------------- |--------------|
| port | Port the app runs on. 7001 by default. |
| host | 0.0.0.0 by default. |
| resourceUriPrefix | Prefixes all resources with a URI. |
| resourceDir | Directory containing your resources. Default to sample-resources. |
| proxy | Object containing the host and port of the URL to proxy to. No default. |
| staticDir | Path to static directory to serve. |
| staticUri | URI to serve static directory through. |