json-server-router

 

简体中文 | English

json-server-router

> 简约但强大的 mock server 构建命令行工具

- json-server-router
- 开始
- 命令参数
- 参数说明
- jsr.config.js simple
- 路由规则
- 路由生成规则示意
- 路由生成工具命令
- 自定义路由
- rewrite
- 功能介绍
- Filter
- Paginate
- Sort
- Slice
- Operators
- Full-text search
- Relationships
- ~~POST PUT DELETE~~ 目前全部跟 GET 一致
- 文件上传
- 生成随机数据
- 默认集成 mockjs
- 战斗人员可以作为json-server中间件引用
- Q&A
- 演示

开始

install json-server-router

``bash
$ npm install json-server-router -g
`
目前 mock 文件支持 .json .jsonc .js 三种格式。
假设有文件books.json内容如下：

`json
// books.json
{
"update": { "code": 200, "message": "succeed", "data": true },
"retrieve": { "code": 200, "message": "succeed", "data": true },
"create": { "code": 200, "message": "succeed", "data": true },
"delete": { "code": 200, "message": "succeed", "data": true }
}
`

运行命令$ jsr books.json

将以books.json为数据源启动 mock server，
对应生成四个接口 /books/update /books/retrieve /books/create /books/delete，其中文件中每个键值成为一个接口。

运行$ curl http://localhost:3000/books/update

返回

`js
{
"code": 200,
"message": "succeed",
"data": true
}
`

命令参数

`bash
jsr [options]

Examples:
jsr .
jsr mock
jsr books.json
jsr books.jsonc
jsr index.js


位置：
root Paths to mock files dir or file 支持 .json .jsonc .js 三种格式文件 [字符串]

选项：
--config Path to config file [string] [default:
jsr.config.js]
--port, -p Set port [数字] [默认值: 3000]
--host [字符串] [默认值: 本机IP]
--watch, -w Watch file(s) [布尔] [默认值: true]
--open, -o open [布尔] [默认值: false]
--help, -h 显示帮助信息 [布尔]
--version, -v 显示版本号 [布尔]
`

$3

- config 设置配置文件默认配置文件的地址是当前目录的下的jsr.config.js
- watch 监控文件变化自动重新加载

$3

`js
module.exports = {
root: 'mock',
port: 3000
}
`


路由规则

如果想构建复杂的路由结构该怎么办？json-server-router 提供一个便捷的方式创建复杂路由，你只需按照一定的规则构建出对应的目录结构就好。

假设我们的目标接口为 /aaa/bbb/ccc/update，那么我们只需构造出如下的目录结构

> tips 当遇到名称为 index 的文件路径拼接的时候会忽略index，当遇见键值为 index路径拼接同样也会忽略index

- name --> prefix/name // prefix 文件目录结构 name 对象key

`bash
- aaa
- bbb
+ ccc.json // 在ccc.json中添加 update
or

- aaa
- bbb
- ccc
+index.json // 在index.json中添加update

`

运行$ jsr aaa就会得到目标接口；


$3

`bash
-mock
+ index.json ------> /xxx
+ book.json ------> /book/xxx
- foo
+ index.json ------> /foo/xxx
+ bar.json ------> /foo/bar/xxx
`

- 文件名为index.{js,json,jsonc} 生成路由时忽略 index
- /xxx/aaa/index 路径指向 /xxx/aaa

$3

为了解决复杂路由需要构建复杂目录结构的问题，现提供$ jsr route 工具命令以便按照路由规则生成对应目录结构.

`bash
$ jsr route /aaa/bbb/ccc/update
$ jsr ro /aaa/bbb/ccc/update # 简写
`

运行上述命令将自动生成目录结构mock/aaa/bbb/ccc.json

并且ccc.json自动生成如下内容

`json
{
"update": {
"code": 0,
"data": {},
"msg": "msg"
}
}
`


$3

- /aaa/bbb/name --> prefix/aaa/bbb/name // prefix 文件目录结构

当对象 key 以/ 即认为启动自定义路由,以解决创建多层目录的弊端，假设 index.json 内容如下那么将生成路由/update/more/book

`js
// index.json
{
"/update/more/book": {
"code": 200,
"message": "自定义路由",
"data": true
},
"retrieve": { "code": 200, "message": "succeed", "data": true }

}
`




$3

在 jsr.config.js 中添加 routes 字段,注意每个 route 必须以 / 开头

`js
// jsr.config.js
module.exports = {
/**
* /api/posts # → /posts
* /api/posts/1 # → /posts/1
* /posts/1/show # → /posts/1
* /posts/javascript # → /posts?category=javascript
* /articles?id=1 # → /posts/1
*/
routes: {
'/api/*': '/$1',
'/:resource/:id/show': '/:resource/:id',
'/posts/:category': '/posts?category=:category',
'/articles\\?id=:id': '/posts/:id'
}
}
`
了解更多: josn-server coutom routes express-urlrewrite

功能介绍

> json-server-router是对json-server的扩展所以要想更好的理解下面的内容最好要先了解json-server

$3

Use . to access deep properties

`
GET /posts?title=json-server&author=typicode
GET /posts?id=1&id=2
GET /comments?author.name=typicode
`

$3

Use _page and optionally _limit to paginate returned data.

In the Link header you'll get first, prev, next and last links.

`
GET /posts?_page=7
GET /posts?_page=7&_limit=20
`

_10 items are returned by default_

$3

Add _sort and _order (ascending order by default)

`
GET /posts?_sort=views&_order=asc
GET /posts/1/comments?_sort=votes&_order=asc
`

For multiple fields, use the following format:

`
GET /posts?_sort=user,views&_order=desc,asc
`

$3

Add _start and _end or _limit (an X-Total-Count header is included in the response)

`
GET /posts?_start=20&_end=30
GET /posts/1/comments?_start=20&_end=30
GET /posts/1/comments?_start=20&_limit=10
`

_Works exactly as Array.slice (i.e. _start is inclusive and _end exclusive)_

$3

Add _gte or _lte for getting a range

`
GET /posts?views_gte=10&views_lte=20
`

Add _ne to exclude a value

`
GET /posts?id_ne=1
`

Add _like to filter (RegExp supported)

`
GET /posts?title_like=server
`

$3

Add q

`
GET /posts?q=internet
`

$3

To include children resources, add _embed

`
GET /posts?_embed=comments
GET /posts/1?_embed=comments
`

To include parent resource, add _expand

`
GET /comments?_expand=post
GET /comments/1?_expand=post
`

To get or create nested resources (by default one level, add custom routes for more)

`
GET /posts/1/comments
POST /posts/1/comments
`

当使用json-server 我们可以通过构建路由/get/users?_page=7&_limit=10进行分页查询但是query的关键词必须是指定的,
在json-server-router中可以再jsr.config.js中自定义queryMap字段来修改关键词的名字，配置好了之后就可以通过/get/users?page=7&len=10进行分页查询

`js
//jsr.config.js
{
queryMap: [
['_page', 'page'],
['_limit', 'len']
]
}
`

~~POST PUT DELETE~~ 目前全部跟 GET 一致

~~关于非GET请求你不需要定义mock files，json-server-router对所有非GET请求进行统一处理不管其路由是什么一致通过 handler 函数处理~~

文件上传

jsr 支持文件上传功能只要添加 file 魔法注释即可"upload[file]",目前上传文件对应的name固定为file

`json
{
"upload[file]": { "code": 200, "message": "succeed", "data": true }
}
`

/xxxx/upload返回结果如下：

`json
{
"code": 200,
"files": [
{
"destination": "public/temp",
"encoding": "7bit",
"fieldname": "file",
"filename": "0668151cf3f749154c6b1942abe38ad6",
"mimetype": "application/javascript",
"originalname": "jsr.config.js",
"path": "public/temp/0668151cf3f749154c6b1942abe38ad6",
"size": 494
}
]
}
`

推一手httpie：使用 httpie 如下命令即可完成上传文件的功能：

$ http -f xxxx/upload file@somefile.xx

生成随机数据

Using JS instead of a JSON file, you can create data programmatically.

`javascript
// index.js
module.exports = () => {
const data = { users: [] }
// Create 1000 users
for (let i = 0; i < 1000; i++) {
data.users.push({ id: i, name: user${i} })
}
return data
}
`

`bash
$ jsr index.js
`

Tip use modules like Faker, Casual, Chance or JSON Schema Faker.

默认集成 mockjs

为了更好的支持生成随机数据的需求现在默认集成mockjs

举例说明：可以在 mock 文件中直接使用 mockjs 语法如下文例子所示

`js
// mockjs 例子
module.exports = {
// 属性 list 的值是一个数组，其中含有 1 到 10 个元素
'list|10': [
{
// 属性 id 是一个自增数，起始值为 1，每次增 1
'id|+1': 1,
// 随机中文名
name: '@cname',
// 随机地址
address: '@city(true)',
web: '@url',
guid: '@guid',
// 生成 200x 200 的图片
image: "@image('200x200')",
constellation: '@constellation',
// 三选一
'oneOf|1': ['one', 'two', 'three'],
// 生成满足正则条件的字符串
regexp1: /[a-z][A-Z][0-9]/,
regexp2: /\w\W\s\S\d\D/,
regexp3: /\d{5,10}/
}
]
}
`

战斗人员可以作为json-server中间件引用

可以参考cli/server.js

`js
const jsonServer = require('json-server')
const server = jsonServer.create()
const middlewares = jsonServer.defaults() // { static: 'public' }
const JsonServerRouter = require('json-server-router')

/**
* @prop {string} root mock文件根目录默认为 'mock'
* @prop {number} port 端口号跟json-server 一致 默认为 3000
* @prop {string} publicPath 生成默认首页的地址，跟json-server 配置一致 默认'public',如果修改路径的话那么json-server 对应的配置也要改
* @prop {bool} open 是否用浏览器打开 默认 true
*/

const router = new JsonServerRouter({
root: 'mock',
port: 3000,
publicPath: 'public'
})

server.use(middlewares)

server.use(router.routes())
server.use(router.rewrite())

server.listen(3000, () => {
console.log('JSON Server is running')
})
`

Q&A

如有疑问可直接加微信面基 advence-liz`

演示