2025年swagger2关闭（swagger2关闭配置）

科技前沿 • 2025-06-16 16:12 • 阅读 36

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

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

1）接口的文档在线自动生成。

2）功能测试。

第一步：导入swagger依赖包

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

</dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

</dependency>

第二步：创建swagger配置文件

@Api : 用在类上，描述该类的主要作用。

@ApiOperation：用在方法上，给API增加方法描述。

@ApiImplicitParams : 用在方法上，包含一组参数描述。

@ApiImplicitParam：用来注解来给方法入参增加描述。

@ApiResponses：用于表示一组响应。

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息。

code：数字，例如500

message：信息，例如“请求参数异常”

response：抛出异常的类

@ApiModel：用在返回对象类上，描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）。

@ApiModelProperty：描述一个model的属性。

方式一：

在Swagger2Config上使用@Profile注解标识，@Profile({“dev”,“test”})表示在dev和test环境才能访问swagger-ui.html，prod环境下访问不了。

方式二：

在Swagger2Config上使用@ConditionalOnProperty注解，

@ConditionalOnProperty(name = “swagger.enable”, havingValue = “true”)

表示配置文件中如果swagger.enable =true表示开启。所以只需要在开发环境的配置文件配置为true，生产环境配置为false即可。

本人比较喜欢第一种方式，因为第二种方式还要在每个环境文件中去配置，并维护；Swagger一般用于开发和测试环境，所以直接限制Swagger启用的环境为dev和test即可，这样也不需要再维护配置文件了。