SuperAPI AI 工具集

unit-test-wiremock-rest-api

编程与开发

查看项目

更新于 10-15 21:53

技能介绍

用途:为调用外部 REST API 的服务编写单元测试,通过 WireMock 打桩 HTTP 响应,避免依赖真实网络。

主要能力:打桩响应(stubFor 匹配 URL、请求头、请求体);校验请求细节(verify 检查请求头、查询参数、请求体);模拟错误场景(超时、4xx/5xx、畸形响应);使用动态端口避免并行测试冲突。

使用方式:在测试作用域添加 WireMock 依赖(Maven 示例:org.wiremock:wiremock:3.4.1,scope 为 test;断言可用 assertj-core)。用 @RegisterExtension 注册 WireMockExtension,配置 wireMockConfig().dynamicPort()。以 wireMock.getRuntimeInfo().getHttpBaseUrl() 作为客户端 base URL。用 stubFor() 定义响应,调用服务方法后用 AssertJ 断言,再用 verify() 校验请求。

适用场景:测试调用第三方 REST API 的服务;需要可预测的 HTTP 响应;覆盖超时、5xx、畸形响应等错误路径;校验请求头、查询参数与请求体。

限制与注意:必须使用动态端口,固定端口会导致并行执行冲突;测试 HTTPS 需配置 WireMock TLS;更具体的桩优先于通用桩;WireMock 有额外开销,追求更快测试可在客户端层 mock;桩需与实际 API 契约保持同步。若桩不匹配,检查 URL 编码、请求头名称,查询参数可用 urlEqualTo;若测试挂起,配置 HTTP 客户端连接超时,用 withFixedDelay() 模拟超时。@RegisterExtension 会在测试间自动重置。始终打桩第三方端点,不要调用真实 API。更多错误场景、请求体校验、超时模拟与有状态测试见 references/advanced-examples.md。