三、SpringBoot中的Swagger2
1、在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>
2、在创建一个配置类SwaggerConfig :
package com.test.law.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createDocke() {
return new Docket(DocumentationType.SWAGGER_2)
//进入swagger-ui的信息
.apiInfo(apiInfo())
.select()
//暴露所有controller类的所在的包路径
.apis(RequestHandlerSelectors.basePackage("com.test.law"))
.paths(PathSelectors.any())
.build();
}
//进入swagger-ui的信息
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
//该项目的名字
.title("Spring Boot 2.x教程")
//该项目的描述
.description("spring boot2.x 描述")
.version("1.0")
.build();
}
}
3、在controller中的类上添加注解 @Api(value = “SpringBoot Study Test”)
在方法上添加注解 @ApiOperation(value = “test”, notes = “test”)
4、打开swagger:http://localhost:8012/swagger-ui.html#/
5、swagger界面