如何结合StepVerifier与Spring Rest Docs实现响应式接口测试及文档生成

我明白你想要的是——既用StepVerifier对响应式流做精细化的验证，又不丢掉Spring Rest Docs自动生成API文档的能力，对吧？这完全可以做到，核心是要合理利用WebTestClient的ResponseSpec特性。

先看你现有的两段代码：

• 一段通过consumeWith(document("client-getAll"))完成文档生成
• 另一段通过returnResult<Client>().responseBody拿到响应流，交给StepVerifier验证

其实这两个操作可以在同一个请求流程里完成，因为ResponseSpec允许你重复调用expectBody()相关方法。下面是整合后的完整代码：

// 发起请求并验证状态，得到ResponseSpec
val responseSpec = webTestClient.get()
    .uri("/api/clients")
    .exchange()
    .expectStatus().isOk

// 第一步：处理Spring Rest Docs的文档生成
responseSpec.expectBodyList(Client::class.java)
    .consumeWith(document("client-getAll"))

// 第二步：获取响应体流，用StepVerifier做精细化验证
val responseBody = responseSpec.returnResult<Client>().responseBody
StepVerifier.create(responseBody)
    .expectNextCount(1)
    .verifyComplete()

关键原理说明： #

• ResponseSpec是WebTestClient请求后的核心对象，它的方法并非“一次性”调用——你可以多次调用expectBody()或expectBodyList()，分别完成文档生成和响应流提取。
• 先调用consumeWith(document(...))可以让Spring Rest Docs完整捕获请求、响应状态、响应体等所有必要信息，生成符合要求的API文档。
• 之后调用returnResult()拿到的响应流，和直接单独调用时的流是同一个，所以StepVerifier可以正常验证流的行为（比如元素数量、元素内容、完成/错误信号等）。

额外优化： #

如果你需要在生成文档的同时先做一些简单断言（比如响应体大小），可以把断言和文档生成链式结合：

responseSpec.expectBodyList(Client::class.java)
    .hasSize(1) // 先做简单断言
    .consumeWith(document("client-getAll")) // 再生成文档

这种方式既保留了StepVerifier对响应式流的强大验证能力（比如验证元素顺序、错误场景、背压处理等），又能让Spring Rest Docs自动生成规范的API文档，完美结合两者的优势。

内容的提问来源于stack exchange，提问作者CRISTIAN ROMERO MATESANZ