接口数据文档

目录

• 7、接口

 

---

作者：@生活在北极的企鹅
本文为作者原创，转载请注明出处：https://www.cnblogs.com/BJQE/p/16202501.html

---

Top

7、接口

7.1、接口的概念

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

例如

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

http://www.liulongbin.top:3006/api/addbook    添加图书的接口(PosT请求)

 

7.2、分析接口的请求过程

7.2.1、通过GET方式请求接口的过程

7.2.2、通过GET方式请求接口的过程

 

7.3、接口测试工具 

 

 7.3.1、什么是接口测试工具

为了验证接口能否被正常被访问，我们常常需要使用接口测试工具，来对数据接口进行检测。

好处:接口测试工具能让我们在不写任何代码的情况下，对接口进行调用和测试。

 

7.4、接口文档

7.4.1、什么是接口文档

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

7.4.2、接口文档的组成部分

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

1、接口名称： 用来标识各个接口的简单说明，如登录接口，获取图书列表接口等。

2、接口URL： 接口的调用地址。

3、调用方式： 接口的调用方式，如GET或 POST。

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

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

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

 

---

如果您觉得阅读本文对您有帮助，请点一下“推荐”按钮，您的“推荐”将是我最大的写作动力！欢迎各位转载，但是未经作者本人同意，转载文章之后必须在文章页面明显位置给出作者和原文连接，否则保留追究法律责任的权利。