在 Spring Rest Docs 中添加基础 url 的路径？

Question

我有以下配置可用于 Rest Docs：

webTestClient = buildWebClient().mutate()
  .filter(documentationConfiguration(restDocumentation))
  .baseUrl("https://api.my-domain.com/")
  .build()

在我的例子中，我使用我的服务的路径前缀 - service/foo 因为我使用 k8s 入口并且我的服务是在路径偏移量上提供的。

有没有办法在不修改生产代码的情况下插入这样的前缀？

相关文档片段：

https://docs.spring.io/spring-restdocs/docs/current/reference/html5/#configuration-uris-webtestclient

Answer 1

要记录另一个 URI 而不是调用生成文档的 URI，您必须编写自己的 OperationPreprocessor。有一些预定义的像Preprocessors.modifyUris但是它不允许修改请求路径。

检查下面的 webTestClient 配置和 URIUpdaterOperationRequest class。代码在 GitHub 上可用：https://github.com/Query-Interface/SO-Answers/blob/master/java/spring/rest-docs-modify-uripath/src/test/java/com/example/demo/DemoApplicationTests.java

public void init() throws Exception {
    final URIUpdaterPreprocessor preprocessor = new URIUpdaterPreprocessor();
    webTestClient = webTestClient.mutate()
        .filter((documentationConfiguration(this.restDocumentation)
                .operationPreprocessors()
                    .withRequestDefaults(preprocessor)
                    .withResponseDefaults(prettyPrint()))
                )
        .build();
}

private static final class URIUpdaterPreprocessor
    implements OperationPreprocessor {

    @Override
    public OperationRequest preprocess(OperationRequest request) {
        return new URIUpdaterOperationRequest(request);
    }

    @Override
    public OperationResponse preprocess(OperationResponse response) {
        return response;
    }

}

private static final class URIUpdaterOperationRequest
    implements OperationRequest {

    private OperationRequest delegate;

    public URIUpdaterOperationRequest(OperationRequest request) {
        delegate = request;
    }

    public byte[] getContent() {
        return delegate.getContent();
    }

    public String getContentAsString() {
        return delegate.getContentAsString();
    }

    public HttpHeaders getHeaders() {
        return delegate.getHeaders();
    }

    public HttpMethod getMethod() {
        return delegate.getMethod();
    }

    public Parameters getParameters() {
        return delegate.getParameters();
    }

    public Collection<OperationRequestPart> getParts() {
        return delegate.getParts();
    }

    public URI getUri() {
        URI sourceUri = delegate.getUri();
        UriComponentsBuilder builder = UriComponentsBuilder.fromUri(sourceUri);
        return builder
            .host(sourceUri.getHost())
            .replacePath("/service/foo"+sourceUri.getPath())
            .build().toUri();
    }

    public Collection<RequestCookie> getCookies() {
        return delegate.getCookies();
    }
}

我认为另一种可能性是更新 mustache 模板，以便在所有请求路径引用之前添加一个前缀。默认模板是 located here on github.

在 Spring Rest Docs 中添加基础 url 的路径？

Adding path to base url in Spring Rest Docs?

kotlin

spring-restdocs

spring-webflux