通用接口API规范
- 保持幂等。也即多次调用,应该产生一致的结果,例如转账1元,因为调用失败或者超时重试的时候,最终结果还应该是转账1元,而非调用两次变成转账2元。
- 接口的实现应该尽量避免阻塞,可以使用异步方式提升性能。
- 接口应该包括能够区分不同情况的异常,而非抛出宽泛的Exception,不能吞掉异常。
- 接口的实现要有足够的容错性,以及对不同版本的兼容性。当要引入新接口的时候,使用先添加,后删除的方式。
- 接口应该有良好的注释
测试怎么做
【第一步】获取接口说明文档
接口说明文档内容包含:接口地址、接口协议类型,接口报文支持格式(json或xml)、请求方式(get或post)、接口备注(描述接口所实现的功能)、请求参数说明、返回参数说明、请求示例、返回示例。
【第二步】确定测试目标
如:功能测试,性能测试,安全测试等