## 什么是swag?
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。简单来说,可以更友好的展示自己对外的API,调用、测试更加方便、轻松。
下面的操作都是以maven构建的springboot项目为基础。
- 首先要做的就是引入swag的jar包
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.5.0</version>
</dependency>
- 配置config类
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
// 为当前包路径
.apis(RequestHandlerSelectors.basePackage("learn.controller")).paths(PathSelectors.any()).build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 页面标题
.title("练手搭建springboot项目")
// 创建人
// .contact(new Contact("ljg", "http://blog.bianxh.top/", ""))
// 版本号
.version("1.0")
// 描述
.description("API 描述").build();
}
}
- 注解需要暴露的接口
@Api(value = "用户", tags = { "用户