您如何使用Spring RestDocs记录WebFlux响应的字段？

问题描述

我有一个API，其提供的响应分别为"abchd\kdgf" 和Flux，它们又提供了JSON负载作为服务器发送事件。

我还使用Mono记录该有效载荷的内容。这些是在Spring RestDocs和

中生成的

我可以使用WebFluxTest生成一个简单的ResponseBody代码段，但是当我尝试使用字段描述符来描述字段时...

PayloadDocumentation.responseBody()

我得到以下失败的测试：

@WebFluxTest
@AutoConfigureRestDocs
@ContextConfiguration(classes = ArticleHandler.class)
class HandlerTest { 
...

    @Test
    void testGetArticle() {
        webClient.get()
                .uri("/articles/{id}","article-id")
                .exchange()
                .expectStatus().isOk().expectBody().consumeWith(
                        document("article",PayloadDocumentation.responseFields(fieldWithPath("id")
                        .type(JsonFieldType.STRING)
                        .description("Unique ID for blog article")));
    }
}

有什么方法可以记录[Fatal error] :1:1: Content is not allowed in prolog. Cannot handle text/event-stream;charset=UTF-8 content as it Could not be parsed as JSON or XML org.springframework.restdocs.payload.PayloadHandlingException: Cannot handle text/event-stream;charset=UTF-8 content as it Could not be parsed as JSON or XML at org.springframework.restdocs.payload.ContentHandler.forContentWithDescriptors(ContentHandler.java:69) at org.springframework.restdocs.payload.AbstractFieldsSnippet.createModel(AbstractFieldsSnippet.java:157) at org.springframework.restdocs.snippet.TemplatedSnippet.document(TemplatedSnippet.java:78) at org.springframework.restdocs.generate.RestDocumentationGenerator.handle(RestDocumentationGenerator.java:191) at org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.lambda$document$0(WebTestClientRestDocumentation.java:77) at org.springframework.test.web.reactive.server.DefaultWebTestClient$DefaultBodyContentSpec.lambda$consumeWith$3(DefaultWebTestClient.java:564) at org.springframework.test.web.reactive.server.ExchangeResult.assertWithDiagnostics(ExchangeResult.java:206) at org.springframework.test.web.reactive.server.DefaultWebTestClient$DefaultBodyContentSpec.consumeWith(DefaultWebTestClient.java:564) at com.project.blog.article.HandlerTest.testGetArticle(HandlerTest.java:62) 有效载荷中发出的对象？

解决方法

编辑：作为参考，这是“操作”中的完整类：https://github.com/michael-simons/neo4j-from-the-jvm-ecosystem/blob/master/tck/src/test/java/org/neo4j/examples/jvm/tck/TckTest.java#L221-L257

我遵循了Andy's的建议，并实现了这样的预处理器：

import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
import static org.springframework.restdocs.payload.PayloadDocumentation.requestFields;
import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;


import org.springframework.restdocs.operation.preprocess.ContentModifyingOperationPreprocessor;

class Whatever {

    @Test
    @DisplayName("GET /api/movies")
    void verifyGetListOfMovies(@Autowired WebTestClient webclient) {
    
        var movies = webclient.get().uri("/movies")
            .exchange()
            .expectStatus().isOk()
            .expectHeader().value(HttpHeaders.CONTENT_TYPE,s -> {
                    var mediaType = MediaType.parseMediaType(s);
                    var compatibleMediaTypeReturned = mediaType.isCompatibleWith(MediaType.TEXT_EVENT_STREAM) ||
                                                      mediaType.isCompatibleWith(MediaType.APPLICATION_JSON);
                    assertThat(compatibleMediaTypeReturned).isTrue();
                })
            .expectBodyList(Movie.class)
            .consumeWith(document("movies",preprocessResponse(new ContentModifyingOperationPreprocessor(
                    (bytes,mediaType) -> {
                        var result = new StringBuilder().append("[");
                        try (var scanner = new Scanner(new ByteArrayInputStream(bytes),mediaType.getCharset()).useDelimiter("(\r?\n){2}")) {
                            while (scanner.hasNext()) {
                                String statement = scanner.next().trim().replaceAll("^data: *","").trim();
                                if (statement.isEmpty()) {
                                    continue;
                                }
                                result.append(statement).append(",");
                            }
                        }
                        result.replace(result.length() - 1,result.length(),"]");
                        return result.toString().getBytes(mediaType.getCharset());
                    })
            ),responseFields(
                fieldWithPath("born").description("The year in which the person was born."),fieldWithPath("name").description("The name of the person."),fieldWithPath("id").description("The neo4j internal id."))
            ))
            .returnResult()
            .getResponseBody();
    }
}