1.swagger概述
号称世界上最流行的Api框架
RestFul Api文档在线自动生成工具=》Api文档与API定义同步更新
直接运行,可以在线测试接口
官网:https://swagger.io/
2.SpringBoot集成Swagger
2.1新建boot工程
2.2添加依赖 注意swagger版本与boot的版本
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2.3 配置swagger
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
Docket docket(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo());
}
ApiInfo apiInfo (){
ApiInfo apiInfo = new ApiInfo("swagger测试",
"描述信息",
"version-1.0",
"urn:tos",
new Contact("作者", "http://1.2.3.4", "123@163.com"),
"Apache 2.0",
"http://www.apache.org/licenses/LICENSE-2.0",
new ArrayList());
return apiInfo;
}
}
3.4访问
http://127.0.0.1:8080/swagger-ui.html
4swagger注解使用
效果图: