夜雨聆风学习资料网

ARTICLE · 1277726

软件系统的接口检查清单

软件系统的接口检查清单

1、交付物完整性检查

  •  接口源码(含 Controller / Service 各层)
  •  接口文档(API 说明书,Word/PDF)
  •  接口契约文件
  •  接口测试用例文档
  •  接口测试报告
  •  部署配置文件与环境说明
  •  数据库相关脚本(若接口依赖建表/数据变更)
  •  接口版本变更记录
2、文档准确性检查
检查项
方法
标准
接口 URL 路径
对照代码中的 @RequestMapping / @GetMapping
文档与代码完全一致
请求方式
对照代码中的方法注解
GET/POST/PUT/DELETE 一致
请求参数
逐字段核对名称、类型、是否必填、默认值
100% 一致
响应字段
逐字段核对名称、类型、说明
100% 一致
错误码定义
核对文档错误码列表 vs 代码中实际抛出的异常码
全覆盖,无遗漏
鉴权方式
核对文档说明 vs 实际鉴权中间件实现
一致且有效
请求/响应示例
实际调用接口,比对示例报文
示例可运行,返回结构一致
接口状态
标注是否已废弃、是否启用、版本状态
清晰标注

3、契约合规性检查

  •  是否遵循 RESTful 设计规范(资源命名、HTTP 方法语义)
  •  是否有明确的接口版本控制(URL 版本 / Header 版本 / 字段版本)
  •  请求参数是否区分必填与可选,是否明确说明
  •  参数类型是否明确(整数、字符串、枚举、日期格式)
  •  是否定义统一的返回结构(如 {code, message, data})
  •  错误码是否分类体系化(业务错误 / 系统错误 / 鉴权错误)
  •  是否定义分页规范(分页参数命名、返回结构)
  •  时间格式是否统一(ISO 8601 / 时间戳)
  •  枚举值是否有完整定义与说明
  •  是否声明数据敏感级别与脱敏要求
  •  是否有幂等性说明(POST 是否支持重复调用)
4、功能正确性检查

(1)基本校验

  •  正常参数调用,返回 200/201,数据结构符合预期
  •  必填参数缺失 → 返回 400,错误码正确
  •  参数类型错误 → 返回 400,错误信息清晰
  •  分页接口:页码/页大小正确,总数一致
  •  增删改查:操作后数据状态正确(数据库验证)
  •  关联接口:调用方按依赖顺序调用,整体流程通过

(2)数据一致性校验

  •  写操作落库后,查操作能查到,数据无错漏
  •  并发调用时,数据不脏不串(如转账、库存场景)
  •  事务性:一个请求内多个表操作,成功全成功、失败全回滚
5、异常与边界检查
检查类别
检查场景
预期行为
参数校验
空值、超长字符串、特殊字符(<script>/'/")
400,明确错误信息
边界值
数字最大值/最小值、日期最早/最晚、分页 pageSize=0/超大值
合理处理,不崩溃
不存在资源
传入不存在的 ID/Key
404,不泄露其他信息
重复提交
同一请求连续多次调用
幂等处理或合理拒绝
并发竞争
同一资源同时被多个请求修改
不出现数据错乱
依赖不可用
调用第三方接口超时/失败
降级或明确错误码,不阻塞
权限不足
未登录/无权限用户调用
401/403,不返回业务数据

6、非功能性质量检查

(1)性能检查

指标
方法
参考标准(以合同为准)
响应时间
JMeter/LoadRunner压测
P95 ≤ 约定值(通常 ≤ 500ms / 2000ms)
吞吐量
压测 TPS
≥ 需求约定值
并发能力
并发用户数测试
不出现大量超时/错误
资源占用
监控 CPU / 内存 / 连接池
无持续泄漏,恢复平稳

(2)安全检查

  • 鉴权有效性:无 Token / Token 过期 / Token 篡改 → 均被拒绝
  • 越权防护:用户 A 无法访问用户 B 的数据(水平越权)
  • SQL 注入:参数中拼接 SQL 特殊字符,确认已参数化处理
  • XSS:参数中注入 <script> 等,确认已过滤/转义
  • 敏感信息保护:日志/错误信息不暴露密码、密钥、Token 原文
  • 传输安全:是否强制 HTTPS(生产环境)
  • 频率限制:是否有接口限流/防刷机制

(3)稳定性检查

  •  连续运行,无内存泄漏(监控堆内存趋势)
  •  长时间运行后响应时间无明显劣化
  •  异常后能自动恢复(连接池/线程池不死锁)

7、联调可用性检查

站在调用方(前端 / 第三方系统)的角度验证:

  •  调用方能正确获取接口文档并理解
  •  联调环境可用(地址、端口、白名单配置正确)
  •  测试账号/Token 可用
  •  示例请求调用方可以直接复制运行
  •  前端/第三方实际集成联调通过
  •  错误信息足够清晰,调用方能定位问题
  •  提供 SDK / 调用代码片段(如有约定)

8、验收检查表

#
检查项
检查结果(✅/❌)
备注
1
接口源码已交付
2
接口文档已交付
3
接口契约文件(Swagger/Postman)已交付
4
接口测试用例已交付
5
接口测试报告已交付
6
部署说明已交付
7
接口文档与代码实现一致
8
接口文档与实际返回一致
9
所有接口正向用例通过
10
所有接口异常用例通过
11
所有接口边界用例通过
12
错误码定义完整且与代码一致
13
鉴权机制有效(未登录/无权限拒绝)
14
无 SQL 注入风险
15
无 XSS 风险
16
敏感信息无泄露
17
性能指标达标(响应时间/TPS)
18
连续运行稳定,无内存泄漏
19
调用方联调通过
20
致命/严重缺陷为 0
21
一般缺陷已修复或有遗留说明

回首页,搜索你想要的文档

在首页搜索框输入关键词,快速定位资料

文库首页搜索指引 立即搜索

相关学习资料