API接口之json-server和JSONPlaceholder

Json-Server

环境

需要安装 node.js

开始

1.全局安装json-server:npm install -g json-server,可通过json-server -h测试

2.新建一个文件夹,如JSONSERVER,然后cd JSONSERVER进入文件夹中.

2.初始化项目 npm init -y

3.安装依赖模块npm install --save-dev json-server

4.在项目根目录下,新建一个 JSON 文件db.json

1
2
3
4
5
6
7
8
9
{
"posts": [
{ "id": 1, "title": "json-server", "author": "typicode" }
],
"comments": [
{ "id": 1, "body": "some comment", "postId": 1 }
],
"profile": { "name": "typicode" }
}

5.打开 package.json,修改scripts:

1
2
3
"scripts": {
"json:server": "json-server --watch db.json"
}

6.启动服务 npm run json:server

至此三个接口已经生成,支持post(新增) delete(删除) put(修改) get(查询);
推荐使用 postman 进行测试

7.如果想把一个接口中的数据拿过来,可以在package.json文件中进行修改:

1
2
3
4
"scripts": {
"json:server": "json-server --watch db.json"
"json:server:remote":"json-server http://jsonplaceholder.typicode.com/db"
},

然后重新npm run json:server:remote就可以了。

8.查看相关内容参考指令:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
// 获取所有用户信息
http://localhost:3000/users

// 获取id为1的用户信息
http://localhost:3000/users/1

// 获取公司的所有信息
http://localhost:3000/companies

// 获取单个公司的信息
http://localhost:3000/companies/1

// 获取所有公司id为3的用户
http://localhost:3000/companies/3/users

// 根据公司名字获取信息
http://localhost:3000/companies?name=Microsoft

// 根据多个名字获取公司信息
http://localhost:3000/companies?name=Microsoft&name=Apple

// 获取一页中只有两条数据
http://localhost:3000/companies?_page=1&_limit=2

// 升序排序 asc升序 desc降序
http://localhost:3000/companies?_sort=name&_order=asc

// 获取年龄30及以上的
http://localhost:3000/users?age_gte=30

// 获取年龄在30到40之间
http://localhost:3000/users?age_gte=30&age_lte=40

// 搜索用户信息
http://localhost:3000/users?q=h h指的是查询的首字母

官方文档:https://www.npmjs.com/package/json-server

JSONPlaceholder

JSONPlaceholder提供免费的在线REST服务(测试用的HTTP请求假数据)。我们在开发时可以使用它提供的 url 地址测试下网络请求以及请求参数。或者当我们程序需要获取一些假数据、假图片时也可以使用它。

其返回的数据为 JSON 格式,且同时支持 HTTP 和 HTTPS 这两种请求类型。

网站地址:http://jsonplaceholder.typicode.com/

GitHub:https://github.com/typicode