Document how to use Spring REST Docs with the WebTestClient with Spring-Boot

[brneto]

Where in the documentation I could present a example of using it with WebTestClient + Spring-Boot.
e.g.

@WebFluxTest
@AutoConfigureRestDocs
class ControllerTests {

    private WebTestClient webClient;

    @BeforeEach
    void setUp(
            @Autowired ApplicationContext context,
            @Autowired WebTestClientRestDocumentationConfigurer configurer) {

        webClient = WebTestClient
                .bindToApplicationContext(context)
                .configureClient()
                .filter(configurer)
                .entityExchangeResultConsumer(document("{class-name}/{method-name}"))
                .build();
    }
}

[wilkinsona]

Thanks for the suggestion. @AutoConfigureRestDocs is a Spring Boot feature and it’s already covered in its reference documentation.

[brneto]

@wilkinsona But in this case there's misleading information between the Spring Boot and the Spring REST Docs documentation.

The Spring REST Docs documentation states that we "cannot parameterise the output directory when using WebTestClient." That's where I'm making myself available to add my code example above.

[wilkinsona]

I'm with you now. Thanks for the clarification. That's already been taken care of in the latest snapshots. See #713 for details and https://docs.spring.io/spring-restdocs/docs/2.0.6.BUILD-SNAPSHOT/reference/#documentating-your-api-parameterized-output-directories for the updated docs.

[brneto]

@wilkinsona What do you think we also add a JUnit 5 example somewhere in this documentation?

[wilkinsona]

The documentation already has a section on using JUnit 5.

[brneto]

Great! Thanks @wilkinsona !

Shouldn't we also comment somewhere that we could also obtain the WebTestClientRestDocumentationConfigurer bean from the context if the test class is using the @AutoConfigureRestDocs annotation?

Sorry keep bothering you! :|

[wilkinsona]

Generally speaking, there's no need to do so. The REST Docs auto-configuration in Spring Boot will apply the WebTestClientRestDocumentationConfigurer to the auto-configured WebTestClient automatically. As you're using @AutoConfigureRestDocs, your example above should probably be changed to use a WebTestClientBuilderCustomizer to add the entityExchangeResultConsumer to the client.

[brneto]

Would be possible share with me a link to any documentation explaining how I could change my example to use WebTestClientBuilderCustomizer instead, please?

[wilkinsona]

I don't think we have a specific example for this particular combination. WebTestClientBuilderCustomizer is documented here. You use one to apply your customizations which, in this case, is the addition of the entity exchange result consumer. That allows you to replace your @BeforeEach method and inject the WebTestClient instead. In combination, that leaves your test class looking something like this:

@WebFluxTest
@AutoConfigureRestDocs
class ControllerTests {

	@Autowired
	private WebTestClient webTestClient;

	@TestConfiguration
	static class RestDocsParameterizedOutput {

		@Bean
		WebTestClientBuilderCustomizer restDocsParameterizedOutput() {
			return (builder) -> builder.entityExchangeResultConsumer(document("{class-name}/{method-name}"));
		}

	}

}