使用注解在Spiringboot项目中配置Swagger2

最新推荐文章于 2024-09-09 00:23:25 发布

What丶About us

最新推荐文章于 2024-09-09 00:23:25 发布

阅读量202

点赞数

分类专栏： java 文章标签： swagger srpingboot swaggerui

本文链接：https://blog.csdn.net/QingDSL/article/details/103317244

版权

java 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

配置步骤

swagger是什么有什么好处这里就不说了，直接上步骤

1.添加依赖

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>
  </dependency>
  <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.9.2</version>
  </dependency>

2.添加注解

在启动类上添加注解：@EnableSwagger2
在这里插入图片描述
OK，俩步配置完成。启动之后访问swagger地址http://localhost:9001/swagger-ui.html（地址端口号自己配置），效果如下：

标签是我一个controller加入Swagger的注解之后的展示效果。

Swagger的常用注解

@Api()用于类；
表示标识这个类是swagger的资源
@ApiOperation()用于方法；
表示一个http请求的操作
@ApiParam()用于方法，参数，字段说明；
表示对参数的添加元数据（说明或是否必填等）
@ApiModel()用于类
表示对类进行说明，用于参数用实体类接收
@ApiModelProperty()用于方法，字段
表示对model属性的说明或者数据操作更改
@ApiIgnore()用于类，方法，方法参数
表示这个方法或者类被忽略
@ApiImplicitParam() 用于方法
表示单独的请求参数
@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam
该部分转载自https://blog.csdn.net/u014231523/article/details/76522486，具体用法可以查看该博客。