『居善地』接口测试 — 1.接口和接口文档概念

1、接口的概念

接口又叫API，全称application programming interface：应用程序接口（规范），也就是我们经常会听说Web接口，APP接口。

详细说明：

APP是一种基于C/S架构的应用程序，如抖音、微信等。完整的体验是基于APP客户端和后台云服务端共同作用的结果。

客户端和服务端的数据传递，也就是指客户端向服务端发送请求，服务端响应客户端的过程。

这一系列的通讯都是基于web协议通讯构成的，在利用web协议通讯的时候，企业内通常都会规定客户端和服务端的数据交换格式，这种格式可以是企业内部规定的，也可以是使用webservice国际通用标准，这样一来客户端和服务端就使用同一套标准进行接口间的通讯。

同样的道理，web接口也是如此，web应用通常是B/S架构，客户端是我们熟悉的浏览器。

总结概括：接口就是客户端与服务端之间的标准，或者是共同遵守的一套数据交互的规范。（一般由项目负责人/架构师来制定接口）

2、为什么要使用接口

在项目中未采用接口时：

1. 研发标准不统一，团队磨合难度高。

2. 研发周期长。

3. 可扩展性差。

在项目中使用接口的优点：

1. 统一设计标准。

2. 扩展性灵活。

3. 前后端开发相对独立，前后端都可以使用自己熟悉的技术。

3、接口文档介绍

接口规范以接口文档的形式进行体现，我们做接口测试也是依据接口文档进行测试。

在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。

接口文档基本形式如下：

名称	添加发布会
描述	添加发布会
URL	http://127.0.0.1:8000/api/add_event/
调用方式	POST
请求参数	eid # 发布会 idname # 发布会标题 limit # 限制人数 status # 状态 address # 地址 start_time # 发布会时间
返回值	{‘status’:200,‘message’:’add event success’}
状态码	每一个状态码要有一条用例。 {‘status’:10021,’message’:’parameter error’} {‘status’:10022,’message’:’event id already exists’} {'status':10023,'message':'event name already exists'} {'status':200,'message':'add event success'}
说明	说明参数传入方式，签名校验方式，加密方式等等。

4、接口文档要素

一般情况下，开发前就有相应的接口文档，接口文档的形式有很多种，以excel表格或者Word文档或者使用接口管理工具（如swagger等）输出，接口文档包含以下主要的内容：

（1） 接口名称

接口详情	说明
接口名称	添加发布会
接口描述	调用该接接口会创建一个发布会

（2）接口URL

名称	说明
请求协议	http或者https
接口URL	127.0.0.1:8000/api/add_event/
请求方式	新增(post) 修改(put) 删除(delete) 获取(get)等

提示：接口URL也可以形成URI的形式，就是把服务器地址省略掉，例如：/api/add_event/

（3）请求参数

字段	说明	类型	是否必填	备注
eid	发布会	Number	是	默认：10001
idname	发布会标题	String	是	默认：填写发布会标题
start_time	发布会时间	Date	是	格式：2018-02-06 10:30:00

提示：一般数据类型为String、Number、Object、Array、Date几种类型。

（4）返回值

例如：{‘status’:200,‘message’:’add event success’}，还可以有其他所需字段。

字段	说明	类型	是否必须返回	备注
code	接口状态码	Number	是	成功：200 失败：其他状态码
message	接口信息	String	是	成功：sucess 失败：提示信息

提示：

正常请求参数返回值（必有）。 错误请求参数返回值（看公司要求）。