@ApiIgnore 注解的用法

最新推荐文章于 2025-09-02 11:11:21 发布

原创最新推荐文章于 2025-09-02 11:11:21 发布 · 4.5w 阅读

31 ·

CC 4.0 BY-SA版权

本文详细介绍了如何使用@ApiIgnore注解来排除特定的类、方法或参数，使其不被Swagger UI展示，帮助开发者精确控制API文档的展示内容。

@ApiIgnore 注解主要作用在方法上，类上，参数上。
当作用在方法上时，方法将被忽略；作用在类上时，整个类都会被忽略；作用在参数上时，单个具体的参数会被忽略。

// 真个类被 Swagger 忽略
@ApiIgnore
@RestController
@RequestMapping(value = "/xttblog")
public class XttblogController {}
 
@RestController
@RequestMapping(value = "/xttblog")
public class XttblogController {
 
  // 整个方法被忽略
  @ApiIgnore
  public String hello(){
    return "hello";
  }
 
  // Swagger 上 忽略 User 参数
  public String sayHello(@ApiIgnore User user){
    return "hello " + user.getName();
  }
}