一、Swagger 是什么
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码,允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。
简单来说,就是接口发生修改,运行后,swagger能立即跟着修改,能直接测试,查看接口文档。
今天先实现哈,后续再详细深入讲解都有哪些用法
二、Swagger 如何配置
2.1 添加pom依赖
<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>
2.2 增加配置类
@Configuration
@EnableSwagger2
public class Swagger {
@Bean
public Docket createRestApi() {
ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<Parameter>();
tokenPar.name("Authorization").description("AccessToken令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
pars.add(tokenPar.build());
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.demo.controller"))
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build()
.globalOperationParameters(pars);
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("JAVA接口文档")
.description("接口描述")
.termsOfServiceUrl("http://www.baidu.com/")
.version("1.0")
.build();
}
3、如何引用
首先在接口类上加:
Api(tags={"字典接口服务"})
在方法上加:
@ApiOperation(value = "字典查询接口")
如下图:
运行Springboot 项目,访问地址:http://localhost:8087/swagger-ui.html
如下图就表示swagger配置成功了