Spring Boot的热部署工具“AND”Swagger测试工具

Spring Boot的热部署&Swagger测试页面的使用

热部署指的是在项目无需重启的情况下，只需要刷新页面，即可获得已经修改的样式或功能。要注意该工具一般用于开发环境，在生产环境中最好不要添加这个工具。

对于无需重启便可刷新这么方便的工具，在项目中该如何使用：

在spring boot 项目中使用工具的方法就是引入相关依赖，热部署工具的依赖如下：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <scope>runtime</scope>
    <optional>true</optional>
</dependency>

只需要将其映入pom.xml文件中，待刷新maven后，该功能部署成功，在以后修改代码只需要刷新网页，即可得到修改后的网页。

Swagger测试工具

首先来看一下swagger工具的创建初衷，该工具的创建是为了解决在微服务中，成千上万的接口文档难以使用人工进行维护的问题，通过对代码添加注解，swagger可以自动生成交互式的api文档，极大的便利了人们对接口文档的修复过程，且降低了维护成本。

swagger工具是一个使用API的集合，可以帮助开发者设计、构建、项目文档化使用Http传输协议。

项目中如果需要添加swagger工具时，需要在文件中引入依赖，pom.xml中添加相关依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

启动项目后就可以通过浏览器去访问swagger UI通常地址为http://127.0.0.1:8080(项目启动的端口号)/swagger-ui.html就可以访问并查看和测试API了。

访问界面如下：

在使用swagger进行测试时，测试人员需要对代码添加注解。swagger的注解分为三种：

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
@Api(tags = "接口名称") //用于整个类的注解方式，一般放在类的最上面
@ApiOperation("方法名称")//在类中需要测试的方法前进行注解
@ApiParam("字段名称")//在属性前进行注解

每添加一个Api类注解，在界面上就会多出一个选项，需要注意的是Api类注解一般是用于controller方法中展开测试。如对一个方法添加了@Api(tags="测试")

具体代码添加项如下：

@Api(tags = "测试")
@RestController
@RequestMapping("自己项目的url")
public class UploadController {
    //具体方法内容
}

以上是对类的添加，接下来是对类中方法添加注解@ApiOperation("方法名称")

@ApiOperation("图片上传")
@PostMapping("/upload")
public ResponseEntity<?> uploadFile(HttpServletRequest request, @RequestParam("file") MultipartFile file){
    //方法实现内容
}

在类中添加示例方法后访问浏览器：

可以看到方法名，那么这就是接口测试的第一步。不要忘了还有一个注解未使用到@ApiParam("字段名称")在属性前面添加整个注解，就可以对这个输入框进行测试。

点击图标上的绿色按钮Try it out。

接着，你就可以对该接口进行测试了，记得多尝试几次，当然当你点击完Exacute时在页面下方可以看到接收到的数据内容。返回的数据内容是与开发者习惯息息相关的，个人这里建议使用简单一点的自定义异常，帮助开发者快速定位错误。

当然当你点击完Exacute时在页面下方可以看到接收到的数据内容。返回的数据内容是与开发者习惯息息相关的，个人这里建议使用简单一点的自定义异常，帮助开发者快速定位错误。

以上就是关于Java两个小工具的分享，谢谢大家观看！