Search code examples
spring-restdocs

How to change host in curl snippet in Spring REST Docs


Spring REST Docs produces a curl snippet which is very convenient when testing. It is equivalent to the MockMvc call as said in its docs but it would be good if its host part can be replaced with a test server's hostname (including port) instead of localhost. Is it possible to achieve it with the current version of it?


Solution

  • You can configure the host (and scheme and port) when you create the MockMvc instance:

    this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
            .apply(documentationConfiguration(this.restDocumentation).uris()
                    .withScheme("https")
                    .withHost("example.com")
                    .withPort(443))
            .build();