@ApiIgnore 注解的用法

@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();
  }
}

忽略的意思就是 swagger-ui.html 上不会显示对应的接口信息。

你可能感兴趣的:(@ApiIgnore 注解的用法)