**swagger **:在线接口管理工具,服务端将接口展示在swagger上面,方便前端人员对接开发。本文针对其好处,记录如何在spring boot项目里面将swagger2 整合。
1,pom依赖:
在pom中导入如下依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
2,编写swagger的配置类如下
@Configuration
@EnableSwagger2//注解开启swagger2
public class SwaggerConfig {
//通过groupName进行分组,paths属性进行过滤,apis属性可以设置扫描包,或者通过注解的方式标识;通过enable属性,可以在application-{profile}.properties文件中设置相应值,主要用于控制生产环境不生成接口文档。
@Bean
public Docket userRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("lty测试模块") //模块名称
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller")) //扫描的控制器路径
.paths(PathSelectors.any())
.build();
}
//接下来的apiInfo方法配置swagger的说明信息,详细信息可以再去查找
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("脚手架测试项目开发接口文档") //接口文档标题
.description("此文档仅供开发测试框架使用使用")
.termsOfServiceUrl("http://km.bbbb.xyz/")
.contact(new Contact("后端开发","heah"))
.version("1.0")
.build();
}
}
3 直接在controller中使用
@RequestMappering(/test)
就可以通过 http://127.0.0.1:8080/swagger-ui.html#
来访问并查看接口信息。
4,swagger 的注解记录
@ApiOperation:说明该方法的用途
value:说明方法的用途,作用
note:方法的备注说明
@Api:说明类的作用
tag:说明该类的作用,可以在swagger界面上看到
value:无需配置
@ApiModelProperty:用在属性上,描述其属性
value:可以是其别名
name :想要映射的字段名称