接口测试?SO ESAY!!!( 三 )

接口信息:接口调用方式 , 常用的GET/POST方式 , 接口地址;

功能描述:简洁清晰的描述接口功能 , 比如:接口获取的信息不包括哪些;

接口参数说明:每个参数都要和实际中调用的一样 , 包括大小写;参数的含义言简意赅的说明 , 格式 , 是string 还是int 还是long等格式;

说明部分 , 说明参数值是需要哪里提供 , 并详细说明参数怎么生成的 , 例如时间戳 , 是哪个时间段的 , 参数是否必填 , 一些参数是必须要有的 , 有些是可选参数等;

返回值说明:

①最好有一个模板返回值 , 并说明每个返回参数的意义;

②提供一个真实的调用接口 , 真实的返回值;

调用限制 , 安全方面:

加密方式 , 或者自己公司一个特殊的加密过程 , 只要双方采用一致的加密算法就可以调用接口 , 保证了接口调用的安全性 , 比如常见的md5;

推荐阅读