Node.js - 接口API

76 阅读2分钟

一、简介

1.1 什么是接口

接口是前后端通信的桥梁
简单理解: 一个接口就是服务中的一个路由规则,根据请求响应结果
接口的英文单词是 API「Application Programming Interface」,所以也称之为 API 接口
这里的接口指的是「数据接口」,与编程语言(Java、Go 等)中的接口语法不同
接口的作用就是实现前后端通信

1.2 接口的开发与调用

大多数接口都是由后端工程师开发的,开发语言不限
一般情况下,接口都是由前端工程师调用的,但有时后端工程师也会调用接口,比如短信接口、支付接口等

1.3 接口的组成

一个接口一般由如下几个部分组成

image.png

二、RESTful API

RESTful API 是一种特殊风格的接口,主要特点如下:

  • URL 中的路径表示资源,路径中不能有动词,例如 create, delete, update 等这些都不能有
  • 操作资源要与 HTTP 请求方法对应
  • 操作结果要与 HTTP 响应状态码对应

规则示例:

操作请求类型URL返回
新增歌曲POST/song返回新生成的歌曲信息
删除歌曲DELETE/song/:id返回一个空文档
修改歌曲PUT/song/:id返回更新后的歌曲信息
修改歌曲PATCH/song/:id返回更新后的歌曲信息
获取所有歌曲GET/song返回歌曲列表数组
获取单个歌曲GET/song/:id返回单个歌曲信息

扩展: www.ruanyifeng.com/blog/2014/0…

三、json-server

json-server 本身是一个js编写的工具包,可以快速搭建 RESTful API 服务
官网地址: github.com/typicode/js…
操作步骤:

  1. 全局安装 json-server
npm i -g json-server

2. 创建 json 文件(db.json),编写基本结构

{
    "song": [
        { "id": 1, "name": "仙儿", "singer": "二手玫瑰" },
        { "id": 2, "name": "稻香", "singer": "周杰伦" },
        { "id": 3, "name": "电梯战神", "singer": "宝石老舅" }
    ]
}

3. 以 json 文件所在文件夹作为工作目录,执行命令

json-server --watch db.json

默认监听端口为 3000

四、接口测试工具