# json-file-server

> [![NPM Version](http://img.shields.io/npm/v/json-file-server.svg?style=flat)](https://www.npmjs.org/package/json-file-server)

Latest version **1.2.3** (published 2015-08-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install json-file-server
pnpm add json-file-server
yarn add json-file-server
bun add json-file-server
```

Provides the command `jfs`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.3 |
| Published | 2015-08-11 |
| First published | 2015-08-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Known vulnerabilities | 0 (+16 in 5 direct dependencies) |
| Install scripts | no |
| GitHub stars | 10 |
| Maintainers | jayinton |

## Links

- npm: https://www.npmjs.com/package/json-file-server
- Repository: https://github.com/Jayin/json-file-server
- Homepage: https://github.com/Jayin/json-file-server#readme
- Issues: https://github.com/Jayin/json-file-server/issues
- npm.io page: https://npm.io/package/json-file-server

## Dependencies (10)

- [cors](https://npm.io/package/cors.md) ^2.7.1
- [jade](https://npm.io/package/jade.md) ~1.9.2
- [debug](https://npm.io/package/debug.md) ~2.1.1
- [lodash](https://npm.io/package/lodash.md) ^3.10.0
- [morgan](https://npm.io/package/morgan.md) ~1.5.1
- [express](https://npm.io/package/express.md) ~4.12.2
- [commander](https://npm.io/package/commander.md) ^2.8.1
- [body-parser](https://npm.io/package/body-parser.md) ~1.12.0
- [cookie-parser](https://npm.io/package/cookie-parser.md) ~1.3.4
- [serve-favicon](https://npm.io/package/serve-favicon.md) ~2.2.0

## Recent versions

- 1.2.3 (latest) — 2015-08-11
- 1.2.2 — 2015-08-11
- 1.2.1 — 2015-08-11
- 1.2.0 — 2015-08-11
- 1.1.1 — 2015-08-11
- 1.1.0 — 2015-08-10
- 1.0.0 — 2015-08-04

## README

# json-file-server
[![NPM Version](http://img.shields.io/npm/v/json-file-server.svg?style=flat)](https://www.npmjs.org/package/json-file-server)

对于前后端完全分离的项目来说，前端只会关心接口，通讯方式一般采用json。所以，理想的状态下就是前端不用直接等待后端完成接口再写逻辑代码，而是直接自己fake一些数据。

参考过[json-server](https://github.com/typicode/json-server),能满足部分需求，然而在实际的上环境比较复杂,以下这2个需求是我迫切需要:

* 请求一些非RESTFUL API (GET /posts/1.json)
* URL有后缀 [add suffix in url #161]()
* fake的数据较大时，比较查看`db.json` 难以看出其数据结构

个人感觉最理想的情况下是，自己根据URL，构成文件夹，文件目录,编写所需的返回数据

### 编写mock file(草案)

URL: `/path/to/Resource[.suffix|''][.Http_Method][?QueryString|'']`

对应文件目录结构:
```
--...
--path
  --blabla
  --to
    --Resource[.suffix|''][.Http_Method|''][?QueryString|'']
```

* Http_Method: Http方法 GET POST PUT DELETE PATCH .....
* suffix 后缀
  * LangPrefix: 语言占位符 e.g: `php`, `do`, `aspx`
  * ReturnType: 返回类型: e.g: `json` & `xml` ,
* QueryString: QueryString，参数顺序问题值得商讨


#### Example

Mock File Name|对应请求方法
-----|-----
`/posts.get` | `GET /posts`
`/posts.post`| `POST /posts`
`/posts.json.post` | `POST /posts.json`
`/post.php.get`| `GET /post.php`
`/posts/1.get?a=1&b=2` | `GET /posts/1?a=1&b=2`
`/posts/1.json.get?a=1` | `GET /posts/1.json?a=1`


### Getting Start

```shell
npm install -g json-file-server
cd path/to/json-file-server # optionals
jfs run -p 3000 .
jfs -help
```

# License

MIT @[Jayin Ton](http://www.jayinton.com)

---
_Source: https://npm.io/package/json-file-server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._