项目整合swagger

标签：接收 必填 项目 boot 参数 整合 swagger 描述

1、 添加依赖

        <!-- swagger -->

　　<dependency>
　　　　<groupId>com.spring4all</groupId>
　　　　<artifactId>swagger-spring-boot-starter</artifactId>
　　</dependency>

为防止报错，请额外添加下面依赖：

　　<dependency>
　　　　<groupId>org.springframework.boot</groupId>
　　　　<artifactId>spring-boot-starter-validation</artifactId>
　　</dependency> 

2、 配置文件

swagger:
　　title: "学习姬"
　　description: "学习平台"
　　base-package: com.study.contentapi.controller　　#指向controller层
　　enabled: true　　#启用swagger
　　version: 1.0.0

3、加注解

@Api：修饰整个类，描述 Controller 的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数 @ApiModelProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP 响应其中 1 个描述
@ApiResponses：HTTP 响应整体描述
@ApiIgnore：使用该注解忽略这个 API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数   @ApiImplicitParam 属性如下：
paramType 查询参数类型
　　path 以地址的形式提交数据
　　query 直接跟参数完成自动映射赋值
　　body 以流的形式提交 仅支持 POST
　　header 参数在 request headers 里边提交
　　form 以 form 表单的形式提交 仅支持 POST
dataType 参数的数据类型 只作为标志说明，并没有实际验证
　　Long
　　String
name 接收参数名
value 接收参数的意义描述
required 参数是否必填
　　true 必填
　　false 非必填 defaultValue 默认值

 

标签：接收,必填,项目,boot,参数,整合,swagger,描述
From： https://www.cnblogs.com/dfym80/p/18021492