API接口（前端学习）

一、简介

1.1 接口是什么

接口是前后端通信的桥梁

简单理解：一个接口就是服务中的一个路由规则，根据请求响应结果

接口的英文单词是API（Application Program Interface）,所以有时也称之为API接口

这里的接口指的是数据接口，与编程语言（Java，Go等）中的接口语法不同

1.2 接口的作用

实现前后端通信

前端负责：

• 浏览器网页
• 安卓App
• 苹果App
• 小程序
• 游戏

后端负责：HTTP服务

1.3 接口的开发和调用

大多数接口都是由后端工程师开发的，开发语言不限

一般情况下接口都是由前端工程师调用的，但有时侯后端工程师也会调用接口，比如短信接口，支付接口等。

1.4 接口的组成

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

• 请求方法
• 接口地址（URL）
• 请求参数
• 响应结果

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

二、RESTful API

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

• URL中的路径表示资源，路径中不能带有动词，例如create、delete、updat等这些都不能有
• 操作资源要与Http请求方法对应
• 操作结构要与Http响应状态码对应

规则实例：

扩展阅读：https//www.ruanyifeng.com/blog/2014/05/restful_api.html

三、json-server

json-server本身是一个JS编写的工具包，可以快速搭建RESTful API服务

官方地址：https://github.com/typicode/json-server

操作步骤：

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":"周杰伦"}
    ],
    "user":[]
}

3.以JSON文件所在文件夹为工作目录，执行如下命令

json-server --watch db.json

默认监听端口为3000

127.0.0.1:3000访问不了时，使用localhost:3000

使用这个命令，两种方式都可以打开

json-server --host 0.0.0.0 --watch db.json

四、接口测试工具

介绍几个接口测试工具

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