json-server详解
1、简介
Json-server 是一个
零代码快速搭建本地 RESTful API 的工具
。它使用JSON 文件作为数据源
,并提供了一组简单的路由和端点,可以模拟后端服务器的行为。github地址:https://github.com/typicode/json-server
npm地址:https://www.npmjs.com/package/json-server
2、安装
json-server是基于npm安装的,安装了node就自动安装了npm,所以安装json-server需要先安装node,node相关知识请参考node入门,npm相关知识请参考npm入门。
安装json-server:
使用npm或yarn全局安装json-server。
npm install -g json-server1
验证安装是否成功:显示版本号就是安装成功了
json-server -v1
3、快速使用
创建JSON文件:
创建一个JSON文件作为数据源,例如db.json
,并在其中定义你想要模拟的数据,例如:
{ "users": [ { "id": 1, "name": "John" }, { "id": 2, "name": "Jane" } ]}
启动json-server:
使用以下命令启动json-server,并将JSON文件作为参数传递给服务器。这将在本地计算机的3000端口
上启动服务器,并将db.json文件中的数据暴露为RESTful API。
json-server --watch db.json1
使用API:
可以使用Web浏览器或任何HTTP客户端程序(如Postman)来访问json-server提供的的数据。例如,以下URL将检索JSON文件中的所有用户:
http://localhost:3000/users1
4、参数说明
语法:
json-server [options]
参数 | 简写 | 说明 | 默认值 |
---|---|---|---|
–config | -c | 指定配置文件路径 | json-server.json |
–port | -p | 指定端口 | 3000 |
–host | -H | 指定主机名 | localhost |
–watch | -w | 监控文件变化 | |
–routes | -r | 指定路由文件路径 | |
–middlewares | -m | 指定中间件文件路径 | |
–static | -s | 指定静态文件文件夹路径 | |
–read-only | –ro | 指定只允许get请求 | |
–no-cors | –nc | 禁止跨域共享 | |
–no-gzip | –ng | 禁止gzip压缩 | |
–snapshots | -S | 指定快照目录 | . |
–delay | -d | 指定延迟返回时长(ms) | |
–id | -i | 指定数据库的ID属性 | id |
–foreignKeySuffix | –fks | 指定外键前缀 | Id |
–quiet | -q | 抑制来自输出的日志消息 | |
–help | -h | 显示帮助 | |
–version | -v | 显示版本号 |
(1)创建json数据
在空文件夹test下,执行命令
json-server --watch db.json1
文件夹下就会生成一个默认内容的
db.json
文件
{ "posts": [ { "id": 1, "title": "json-server", "author": "typicode" } ], "comments": [ { "id": 1, "body": "some comment", "postId": 1 } ], "profile": { "name": "typicode" }}12345678910111213141516171819
访问地址http://localhost:3000/会展示如下页面,可以分别点击
/posts
/comment
/profile
链接,-
能看到各自的json数据。http://localhost:3000/db链接能访问到完整的数据。
以上就是全部内容,感谢大家支持自学php网。