【前端】NodeJS：API（接口）

1 简介

1.1 接口是什么

• 接口是前后端通讯的桥梁。
  
• 简单明白：一个接口就是服务中的一个路由规则 ，根据哀求相应效果。
  
• 接口的英文单词是API（Application Program Interface），以是偶然也称之为API接口。
  
• 这里的接口指的是『数据接口』， 与编程语言（Java，Go 等）中的接口语法差别。
  
• 一个接口就好比是一个服务端中的路由规则，路由规则可以担当客户端发送过来的哀求，而且给客户端相应效果，接口给客户端返回效果时，这个数据一样平常是JSON格式的。
  

1.2 接口的作用

实现前后端通讯。

• 前端：欣赏器网页、安卓APP、苹果APP、小步调、游戏…
  
• 后端：HTTP 服务
  

1.3 接口的开辟与调用

• 大多数接口都是由后端工程师开辟的，开辟语言不限。
  
• 一样平常环境下接口都是由前端工程师调用的，但偶然后端工程师也会调用接口，好比短信接口，付出接口等。
  

1.4 接口的构成

一个接口一样平常由如下几个部门构成：

• 哀求方法
  
• 接口地点（URL）
  
• 哀求参数
  
• 相应效果
  

一个接口示例：https://www.free-api.com/doc/325。

体验一下：https://api.asilu.com/idcard/?id=371522199111299668。
2 RESTful API

RESTful API是一种特别风格的接口，重要特点有如下几个：

• URL中的路径表现资源，路径中不能有动词，比方create、delete、update等这些都不能有。
  
• 利用资源要与HTTP哀求方法对应。
  
• 利用效果要与HTTP相应状态码对应。
  

规则示例：
利用哀求范例URL返回新增歌曲POST/song返回新天生的歌曲信息删除歌曲DELETE/song/10返回一个空文档修改歌曲（全部更换）PUT/song/10返回更新后的歌曲信息修改歌曲（部门更换）PATCH/song/10返回更新后的歌曲信息获取全部歌曲GET/song返回歌曲列表数组获取单个歌曲GET/song/10返回单个歌曲信息扩展阅读：https://www.ruanyifeng.com/blog/2014/05/restful_api.html。
3 json-server

json-server 本身是一个JS编写的工具包，可以快速搭建RESTful API服务。
官方地点：https://github.com/typicode/json-server。
利用步调：

• 全局安装json-server：npm i -g json-server。
  
• 创建JSON文件（db.json），编写根本结构：
  

1. {
2.         "song": [
3.                 { "id": 1, "name": "干杯", "singer": "五月天" },
4.                 { "id": 2, "name": "当", "singer": "动力火车" },
5.                 { "id": 3, "name": "不能说的秘密", "singer": "周杰伦" }
6.         ]
7. }

复制代码

• 以JSON文件地点文件夹作为工作目次，实行下令：json-server --watch db.json。
  
• 默认监听端口为3000。
  

4 接口测试工具

先容几个接口测试工具：

• apipost：https://www.apipost.cn/ (中文)。
  
• apifox：https://www.apifox.cn/ (中文)。
  
• postman：https://www.postman.com/ (英文)。
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！qidao123.com:ToB企服之家，中国第一个企服评测及软件市场,开放入驻,技术点评得现金