SpringBoot集成Swagger java

Swagger简介一：swagger是什么？ Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法,参数和模型紧密集成到服务器。
【SpringBoot集成Swagger】这个解释简单点来讲就是说，swagger是一款可以根据resutful风格生成的生成的接口开发文档，并且支持做测试的一款中间软件。
二：为什么要使用swaager? 2.1:对于后端开发人员来说
不用再手写WiKi接口拼大量的参数，避免手写错误
对代码侵入性低，采用全注解的方式，开发简单
方法参数名修改、增加、减少参数都可以直接生效，不用手动维护
缺点：增加了开发成本，写接口还得再写一套参数配置
2.2:对于前端开发来说
后端只需要定义好接口，会自动生成文档，接口功能、参数一目了然
联调方便，如果出问题，直接测试接口，实时检查参数和返回值,就可以快速定位是前端还是后端的问题
2.3：对于测试
对于某些没有前端界面UI的功能，可以用它来测试接口
操作简单，不用了解具体代码就可以操作
操作简单，不用了解具体代码就可以操作
Swagger

号称世界上最流行的Api框架；
RestFul Api 文档在线自动生成工具=>Api文档与API定义同步更新
直接运行，可以在线测试API接口；
支持多种语言：（Java，Php…）

官方网站：https://swagger.io/
在项目使用Swagger需要 springbox；
SpringBoot 集成Swagger

首先建一个 SPringBoot = web项目
导入依赖

io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2

配置Swagger ====>Config

package com.hhy.swagger.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; import java.util.ArrayList; /** * @author HuangHaiyang * @date 2020/08/18 * @description: description * @version: 1.0.0 */ @Configuration @EnableSwagger2//开启Swagger2 public class SwaggerConfig { @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .enable(true) .select() //RequestHandlerSelectors，配置要扫描接口的方式 //basePackage:指定要扫描的包 //any():扫描全部 //none():不扫描 //withClassAnnotation：扫描类上的注解，参数是一个注解的反射对象 //withMethodAnnotation：扫描方法上的注解 .apis(RequestHandlerSelectors.basePackage("com.hhy.swagger.controller")) //paths()。过滤什么路径 //.paths(PathSelectors.ant("/wu/**")) .build(); } //配置swagger信息 private ApiInfo apiInfo() { Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱"); return new ApiInfo( "Swagger学习", // 标题 "学习演示如何配置Swagger", // 描述 "v1.0", // 版本 "http://terms.service.url/组织链接", // 组织链接 contact, // 联系人信息 "Apach 2.0 许可", // 许可 "许可链接", // 许可连接 new ArrayList<>()// 扩展 ); } }

实体类

@ApiModel("用户实体") public class User { @ApiModelProperty("用户名") public String username; @ApiModelProperty("密码") public String password; }

只有public权限的才能显示

controller

package com.hhy.swagger.controller; import com.hhy.swagger.entity.User; import io.swagger.annotations.ApiOperation; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RestController; /** * @author HuangHaiyang * @date 2020/08/18 * @description: description * @version: 1.0.0 */ @RestController public class HelloController {@GetMapping("/hello") public String hello() { return "hello"; } @ApiOperation("接口描述") @PostMapping("/getUser") public User getUser(){ return new User(); } }

访问 http://localhost:8080/swagger-ui.html#/
swagger常用注解

@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 默认值