如果我在 Spring boot 中對方法有多個映射，如何僅從 swagger ui 文檔中隱藏一個映射

Question

我有一個 spring boot rest 控制器方法，它映射到多個映射。 請在下面找到示例代碼。

@RestController
public class HomeController {

    @RequestMapping( {"/", "/home"} )
    public String home() {
        return "Hello, World!";
    }

}

我想從 swagger 文檔中隱藏/home映射。

有人可以幫助我實現這一目標。

Answer 1

我還搜索了一種從多映射方法中隱藏某些 URL 的方法。 不幸的是，我認為在多重映射時不可能像這樣定義@RequestMapping( {url1, url2} )

有兩種替代方法可以做到：

1. 將您的方法拆分為 2 個調用相同函數的方法，並使用 @Operation(hidden=true) 注釋要隱藏的方法

2. 在您的 swagger 配置中定義異常（對於使用開放 API 的 swagger 3）：

    @Configuration public class SwaggerConfig { @Bean public GroupedOpenApi myApi() { return GroupedOpenApi.builder() .pathsToMatch("/**") .pathsToExclude("/home") .build(); } }