接口

接口的概念

使用Ajax 请求数据时，被请求的 URL 地址，就叫做数据接口(简称接口)。同时，每个接口必须有请求方式。例如 :

http://www.liulongbin.top:3006/api/getbooks                 获取图书列表的接口(GET请求)
http://www.liulongbin.top:3006/api/addbook                  添加图书的接口(POST请求)

 

可以下载 接口测试工具

官方网址 : https://www.postman.com/downloads/

 

使用 postman 添加 POST 请求

 

 

 

使用 postman 发送 GET 请求

 

 

 

接口文档

什么是接口文档

接口文档，顾名思义就是接口的说明文档，它是我们调用接口的依据。好的接口文档包含了对接口URL，参数以及输出内容的说明，我们参照接口文档就能方便的知道接口的作用，以及接口如何进行调用。

接口文档的组成部分

接口文档可以包含很多信息，也可以按需进行精简，不过，一个合格的接口文档，应该包含以下6项内容，从而为接口的调用提供依据:

接口名称:用来标识各个接口的简单说明，如登录接口，获取图书列表接口等。接口URL:接口的调用地址。

调用方式:接口的调用方式，如GET 或 POST.

参数格式:接口需要传递的参数，每个参数必须包含参数名称、参数类型、是否必选、参数说明这4项内容。

响应格式:接口的返回值的详细描述，一般包含数据名称、数据类型、说明3项内容。

返回示例(可选):通过对象的形式，例举服务器返回数据的结构。

 

接口文档示例