详解 swagger2 中屏蔽接口 @ApiIgnore 注解的用法

活到老，学到老。今天有同事问我，为什么有的接口上加的有 @ApiIgnore 注解，有的没有？本文我们一起来解释解释为什么？

Ignore 这个单词，翻译过来就是忽略的意思。api Ignore 和起来就是忽略 api 的意思。

@ApiIgnore 注解是 springfox 中的一个注解。对应源码如下：

package springfox.documentation.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PARAMETER})
public @interface ApiIgnore {
  /**
   * 简要描述为何忽略此参数/操作
   */
  String value() default "";
}

从这个源码中，我们可以看出。@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 用法的解释非常的少，简单的都没人愿意写！

： » 详解 swagger2 中屏蔽接口 @ApiIgnore 注解的用法