一、接口
- 接口的概念
使用 Ajax 请求数据时,被请求的 URL 地址,就叫做数据接口(简称接口)。同时,每个接口必须有请求方式。
例如:
http://www.liulongbin.top:3006/api/getbooks 获取图书列表的接口(GET请求)
http://www.liulongbin.top:3006/api/addbook 添加图书的接口(POST请求)
2. 分析接口的请求过程
2.1 通过GET方式请求接口的过程
2.2 通过POST方式请求接口的过程
二、接口测试工具
1. 什么是接口测试工具
为了验证接口能否被正常被访问,我们常常需要使用接口测试工具,来对数据接口进行检测。
好处:接口测试工具能让我们在不写任何代码的情况下,对接口进行调用和测试。
常用接口测试工具有:
2. 了解PostMan界面组成部分
PostMan界面的组成部分,从上到下,从左到右,分别是:
菜单栏
工具栏
左侧历史记录与集合面板
请求页签
请求地址区域
请求参数区域
响应结果区域
状态栏
3. 使用PostMan测试GET接口
步骤:
①选择GET请求的方式
②填写请求的URL地址
③GET请求选择Params
④填写请求的参数
⑤点击 Send 按钮发起 GET 请求
⑥查看服务器响应的结果
4. 使用PostMan测试POST接口
步骤:
①选择请求的方式
②填写请求的URL地址
③选择 Body 面板
④勾选数据格式x-www-form-urlencoded
⑤填写要发送到服务器的数据
⑥点击 Send 按钮发起 POST 请求
⑦查看服务器响应的结果
三、接口文档
1. 什么是接口文档
接口文档,顾名思义就是接口的说明文档,它是我们调用接口的依据。好的接口文档包含了对接口URL,参数以及输出内容的说明,我们参照接口文档就能方便的知道接口的作用,以及接口如何进行调用。
2. 接口文档的组成部分
接口文档可以包含很多信息,也可以按需进行精简,不过,一个合格的接口文档,应该包含以下6项内容,从而为接口的调用提供依据:
接口名称:用来标识各个接口的简单说明,如登录接口,获取图书列表接口等。
接口URL:接口的调用地址。
调用方式:接口的调用方式,如 GET 或 POST。
参数格式:接口需要传递的参数,每个参数必须包含参数名称、参数类型、是否必选、参数说明这4项内容。
响应格式:接口的返回值的详细描述,一般包含数据名称、数据类型、说明3项内容。
返回示例(可选):通过对象的形式,例举服务器返回数据的结构。