2025年swagger是干嘛的（swagger是什么）

科技前沿 • 2025-06-10 16:59 • 阅读 48

大家好，我是讯享网，很高兴认识大家。

swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的 Web 服务。其总体目标是使客户端和文件系统作为服务器以同样的速度来更新。使得文件的方法，参数和模型紧密集成到服务器端的代码，允许后端接口信息始终保持同步更新。

引入maven依赖信息

设定swagger配置类信息

由于swagger实例Bean是Docket，所以通过配置Docket实例来配置swaggger。

至此，当你访问

在首页中，有很多信息是可以进行设定，比如文档标题信息，文档说明，开发者联系方式等信息。

在swagger中，这些信息可以通过一个Docket中的apiInfo方法来设定，其中apiInfo方法接受一个ApiInfo变量信息，这些变量信息则存放在ApiInfo变量之中。接下来我们通过具体案例来进行说明。

主要可以配置文档标题、版本号、联系人、许可证等信息内容。

默认情况下swagger会扫面所有的信息。但是我们根据自己的喜好进行扫描选项的设定，其设定主要通过select（）方法获取到ApiSelectorBuilder构建对象后在调用apis方法，在其中指定RequestHandlerSelectors去指定扫描的接口信息。

1.扫描所有，项目中的所有接口都会被扫描到（也是默认选项）：any()

讯享网

2.不扫描接口：none()

3.通过方法上的注解扫描，withMethodAnnotation(final Class<? extends Annotation> annotation)



4.通过类上的注解扫描:withClassAnnotation(final Class<? extends Annotation> annotation)



5.根据包路径扫描指定包下的接口信息：basePackage(final String basePackage)

配置通过请求路径配置进行过滤请求时主要通过方法：paths方法，其需要一个Predicate对象来进行设定，此时该对象依赖于PathSelectors进行构建。

PathSelectors中常用方法：

    1.任何请求都扫描：any(）

    2.任何请求都不扫描：none()

    3.通过正则表达式控制:regex(final String pathRegex)

    4.通过ant()表达式控制:ant(final String antPattern)

对于ant表达式：

    ?匹配任何单字符

    *匹配0或者任意数量的字符

    匹配0或者更多的目录

如下图所示为配置了那么当前接口分组信息为user。

配置分组的方式很简单，就是通过构建多个Docket对象即可。

swagger启动方式的配置主要通过enable方法进行实现。

动态获取配置环境信息，根据不同的环境信息制定不同的swagger访问策略。

ignoredParameterTypes()忽略掉某些变量信息的。

2025年swagger是干嘛的（swagger是什么）

相关推荐