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

公告：“业余草”微信公众号提供免费CSDN下载服务(只下Java资源)，关注业余草微信公众号，添加作者微信：xttblog2，发送下载链接帮助你免费下载！
本博客日IP超过2000，PV 3000 左右，急需赞助商。
极客时间所有课程通过我的二维码购买后返现24元微信红包，请加博主新的微信号：xttblog2，之前的微信号好友位已满，备注：返现
受密码保护的文章请关注“业余草”公众号，回复关键字“0”获得密码
所有面试题(java、前端、数据库、springboot等)一网打尽，请关注文末小程序

腾讯云】1核2G5M轻量应用服务器50元首年，高性价比，助您轻松上云

活到老，学到老。今天有同事问我，为什么有的接口上加的有 @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 用法的解释非常的少，简单的都没人愿意写！

最后，欢迎关注我的个人微信公众号：业余草（yyucao）！可加作者微信号：xttblog2。备注：“1”，添加博主微信拉你进微信群。备注错误不会同意好友申请。再次感谢您的关注！后续有精彩内容会第一时间发给您！原创文章投稿请发送至532009913@qq.com邮箱。商务合作也可添加作者微信进行联系！

本文原文出处：业余草： » 详解 swagger2 中屏蔽接口 @ApiIgnore 注解的用法