swagger2作用（swagger2的使用）

科技前沿 • 2025-04-23 22:13 • 阅读 41

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

Swagger是为了解决企业中接口（api）中定义统一标准规范的文档生成工具。方便各大后端小基友的懒问题，但是写注解也是妥妥的麻烦，但是如果版本迭代快或者人员的流动性大，会导致很多问题。所以很多企业中都会有统一的规范文档，来定义接口标准。

参数说明：
name – 参数名
value – 参数说明
required – 是否必须填写
dataType – 数据类型
paramType – 参数类型
example – 举例
常用注解说明：

@Api()用于类；

表示标识这个类是swagger的资源

@ApiOperation()用于方法；

表示一个http请求的操作

讯享网

@ApiParam()用于方法，参数，字段说明；

表示对参数的添加元数据（说明或是否必填等）

@ApiModel()用于类

表示对类进行说明，用于参数用实体类接收

@ApiModelProperty()用于方法，字段

表示对model属性的说明或者数据操作更改

@ApiIgnore()用于类，方法，方法参数

表示这个方法或者类被忽略

@ApiImplicitParam() 用于方法

表示单独的请求参数

@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam

具体使用说明：

1.@Api()

讯享网

2.@ApiOperation()

讯享网

3.@ApiParam()

4.@ApiModel()

讯享网

5.@ApiModelProperty()

6.@ApiImplicitParams() 和@ApiImplicitParam()这两是兄弟就不分开写了

讯享网

看完以上基本的使用说明，接下来我们就开始实战吧！！！

步骤1:当然是pom文件导入依赖

步骤2:启动类添加@EnableSwagger2注解

讯享网

步骤3:编写SwaggerConfig文件

步骤4：

提示：

对于是否暴露swagger，我提供的环境开关配置只是其中之一哦，更多的项目采用的是将页面放到静态页面，再用nginx进行转发后，指定代理环境访问哦。想了解的可以自己试一下哦。

swagger2作用（swagger2的使用）

@Api()用于类；

@ApiOperation()用于方法；

@ApiParam()用于方法，参数，字段说明；

@ApiModel()用于类

@ApiModelProperty()用于方法，字段

@ApiIgnore()用于类，方法，方法参数

@ApiImplicitParam() 用于方法

@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam