如何从swagger ui文档中隐藏一个映射，如果我在Spring boot中对方法进行了多个映射

Question

我有一个映射到多个映射的spring boot rest控制器方法。请查找下面的示例代码。

@RestController
public class HomeController {

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

}

我想从swagger文档中隐藏/home映射。

有人能帮我实现这一目标吗？

Answer 1

我还搜索了一种从多映射方法中隐藏某些URL的方法。不幸的是，我认为当多映射像这样定义时，这是不可能的 @RequestMapping（ {url1， url2} ）

有2种替代方法可以做到这一点：

>

将方法拆分为 2 个调用同一函数的方法，并使用 @Operation（hidden=true） 对要隐藏的函数进行注释

在您的swagger配置中定义异常（对于使用开放API的swagger 3）：

 @Configuration
 public class SwaggerConfig {

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