Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 总体目标是使客户端和文件系统作为服务器以同样的速度来更新。 文件的方法/参数/模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。
1,先在pom.xml文件里面加入依赖
<!--配置swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
2,编写controller,这边我的包路径是com.example.yuanx.controller
/**
* Created by 快乐风男 on 2018/8/23.
*/
@Api(value = "kuaile")
@RestController
public class TestController{
@ApiOperation(value="fengnan")
@GetMapping("/show")
public String show() {
return "success";
}
}
3,编写configuration,这边我的包路径是com.example.yuanx.swagger
/**
* Swagger配置类.
*/
@EnableSwagger2 // Swagger的开关,表示已经启用Swagger
@Configuration // 声明当前配置类
public class SwaggerConfiguration {
@Value("${swagger.basePackage}")
private String basePackage; // controller接口所在的包
@Value("${swagger.title}")
private String title; // 当前文档的标题
@Value("${swagger.description}")
private String description; // 当前文档的详细描述
@Value("${swagger.version}")
private String version; // 当前文档的版本
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(basePackage))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(title)
.description(description)
.version(version)
.build();
}
}
4,配置properties文件
#配置
server.port=8090
# 配置swagger
swagger.basePackage: com.example.yuanx.controller
swagger.title: 快乐风男のAPI
swagger.description: 死亡如风常伴吾身
swagger.version: V1.0
5,在页面上访问
访问地址:http://localhost:端口号/项目名称/swagger-ui.html
当然,也有很多spring boot的项目是没有项目名称的,http://localhost:端口号/swagger-ui.html
本项目的地址是 http://localhost:8090/swagger-ui.html