我报名参加金石计划1期挑战——瓜分10万奖池，这是我的第23篇文章，点击查看活动详情

在执行接口测试前，测试人员肯定会先拿到开发给予的接口文档。测试人员可以根据这个文档编写接口测试用例。所以，我们要先了解接口文档的主要构成及含义。

以购买开心产品项目接口文档为例，解析一下接口文档的组成。

完整的接口文档有公共信息说明、请求响应及加签DEMO、加签代码示例（Python）、接口功能说明、接口参数详细说明5部分组成。接下来我们一一说明。

1．公共信息说明

公共信息说明页分为公共参数说明及请求受理结果代码两部分。

公共参数说明填写多个接口提取的通用参数，这里可以分为请求参数及响应参数。需要填写参数名称、类型、最大长度、描述和用法。请求受理结果代码就是响应码的说明。公共信息说明页如图所示。

2．请求、响应及加签 DEMO

请求、响应及加签DEMO页，如图所示。

一般此页会描述加签的过程，例如分为rsa加签私钥值和服务参数说明。

服务参数说明如下。

（1）对参数名进行从小到大排序。

（2）将参数及参数值拼接成字符串。

（3）用RSA对参数串进行加签后用base64编码，获得签名串。

（4）对各个参数值进行参数值特殊字符的转义。

（5）请求体说明。

加签代码示例部分会填写加签的代码实例，测试人员可以根据加签代码编写测试代码。

接口功能说明填写各接口的主要信息，分为接口名称、接口类型、接口服务代码、接口版本号、备注5部分。接口功能说明如图所示。

接口参数详细说明填写接口的主要信息及参数信息。主要信息分为服务名称、服务代码、服务版本号、服务功能描述、服务提供方系统、服务消费方系统。参数说明又分为中文描述、英文描述、类型、字段长度、是否必填、说明。接口详细说明如图所示。