用JSON-server来做API接口及其示例

通过下面这篇文章我们来了解什么是JSON-server, 如何利用它来做一些临时JSON数据。

1. 什么是JSON-server

简单来说就是把JSON文件当作一个临时的数据库使用的这样一个工具。你可以对其做get, post请求。比如说你想用本地JSON文件来做个数据源,然后用JSON-server来观察管理这个文件,要给这个JSON文件做API请求接口端口的话,利用JSON-server我们就可以跟这个本地JSON文件做交互。
例如,下面的这个blog.JSON文件结构是这样的:

{
 "blogs":[
   {id:1, title:"this is blog title 1"},
   {id:2, title:"this is blog title 2"},
   {id:3, title:"this is blog title 3"},
  ]
}

如果我们对其加入API请求端口的话:

[http://localhost:3000/blogs](http://localhost:3000/blogs) -->get请求博客列表

[http://localhost:3000/blogs](http://localhost:3000/blogs) --> post请求添加新博客

[http://localhost:3000/blogs](http://localhost:3000/blogs)/id --> 获取单个博文的请求

[http://localhost:3000/blogs](http://localhost:3000/blogs)/id --> 删除单个博文的请求

这样我们就可以做一个本地的API接口来进行测试了。

2. 如何安装JSON-SERVER

你的本地环境需要安装nodejs, 这样我们就可以用NPM来安装这个插件了。

npm install -g json-server

安装以后查看下package.json文件里面是不是有这个依赖了。

3.用JSON-server来观察文件

这个比较简单,我们可以直接运行下面的命令:

json-server --watch blog.json

回车以后我们就会看见两个端口:

http://localhost:3000/blogs
http://localhost:3000

blogs这个URL是根据文件里的"blogs"这个对象数组来生成的,如果加入了另一个数组,如:
"articles":[], 那么我们就会看到多了另外一个端口:

http://localhost:3000/artciles

如果你是在windows系统,在运行的时候可能会遇到这种错误:


0810075948.png

如何解决呢?运行下这个命令:

Set-ExecutionPolicy -ExecutionPolicy Unrestricted

4.post请求示例

我们可以对其进行post请求,在HTML里面做一个提交表,下面是一个用fetch来做POST请求的例子:

const url = "http://localhost:3000/blogs";
const form  = document.querySelector("form");

const createPosts = async (e) => {
    
    e.prevenDeault();
    const doc = {
        title:form.title.value,
        content:form.title.value
    }
    
    await fetch(url, {
        method:"post",
        body:JSON.stringify(doc),
        headers:{
            'content-type':'application/json'
        }
    })
    
}

form.addEventListener('submit', createPosts);

一般的数据表里面都有id这个字段,它也会自动进行自增的处理,不用传入。

5. delete请求示例

delte请求跟post请求比较类似,就是把post换成delete便可。

deletebtn = document.addEventListener('.deletebtn');

let id = new URLSearchParams(window.location.search).get('id');
//获取URL 参数

deletebtn.addEventListener('click', async () => {
   await fetch(url+id, {
       method:"DELETE"
   })

})

6.搜索和排序

搜索的时候非常简单,在URL里面加一个搜索参数q就可以了。例如:

http://localhost:3000/blogs?q=searchterm

它会在title和content里面搜索这个关键词

我们可以用某个字段来排序,例如用升序来排博文,也就是ID字段

http://localhost:3000/blogs?_sort=id&_order=desc
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容