简介:
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。
作用:
- 接口的文档在线自动生成。
- 功能测试。
pom.xml
<!-- Swagger -->
<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>
启动类
类上添加 @EnableSwagger2 注释
Controller
添加 @Api(value = “前端控制器”) 和 @ApiOperation(value = “文件上传”, notes = “文件上传”) 注解
访问 http://localhost:8080/swagger-ui.html,可以看到如下效果。(具体端口号根据项目配置不同,默认8080)