Swagger2常用注解 ]和[Springboot整合Swagger2

我敲BUG

已于 2023-04-04 11:22:21 修改

阅读量374

点赞数 1

文章标签： restful 后端

于 2022-05-17 15:49:55 首次发布

本文链接：https://blog.csdn.net/qq_58804301/article/details/124822596

版权

前言：

一.swagger2常用注解

二 .Springboot整合Swagger2

1.创建springboot项目

2.添加依赖

3.添加Swagger2配置类SwaggerConfig

4.API接口编写

5.SpringBoot启动

前言：

swagger是一个RESTFUL 接口的文档在线自动生成和功能测试的框架

一.swagger2常用注解

@Api：用在类上，说明该类的作用。

@ApiOperation：注解来给API增加方法说明。

@ApiImplicitParams : 用在方法上包含一组参数说明。

@ApiImplicitParam：用来注解来给方法入参增加说明。

@ApiResponses：用于表示一组响应

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

@ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）

@ApiModelProperty：描述一个model的属性其中

@ApiResponse参数：

code：数字，如400

message：信息，如“参数填写错误”

response：抛出异常的类 @ApiImplicitParam参数：

paramTpye：指定参数放在哪些地方（header/query/path/body/form）

name：参数名

dataTpye：参数类型

required：是否必输（true/false）

value：说明参数的意思

defaultValue：参数默认值

二 .Springboot整合Swagger2

1.创建springboot项目

2.添加依赖

   <!-- Swagger API文档 -->
     <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger-ui</artifactId>
         <version>2.9.2</version>
     </dependency>
     <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger2</artifactId>
         <version>2.9.2</version>
     </dependency>