SpringBoot如何配置Swagger
SpringBoot如何配置Swagger
·
众所周知,Swagger是一个比较好的API测试工具,今天看了一期狂神说的Spring如何配置Swagger,现在记录一下!!
(1)创建一个SpringBoot项目,利用IDEA工具的Spring Initializr工具进行初始化,在这里如果有的朋友按照默认创建失败的话,我们可以换一下他的地址:https://start.aliyun.com/
(2)注意这里使用的为JDK1.8,在pom.xml文件中引入依赖:
<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>
(3)创建swagger的配置类:
@Configuration //注明这个类为控制类
@EnableSwagger2 //开启Swagger2的自动配置
public class SwaggerConfig {
}
(4)访问swagger地址:http://localhost:8080/swagger-ui.html,若显示如下截图,则说明swagger第一步配置成功配置成功!!
(5)接下来配置Swagger的一些其他参数:在这里配置的话,对于document那个的引入需要注意,具体引入import springfox.documentation.service.Contact;这一点需要注意!!!
package com.swagger.swaggerdemo1.Config;
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 //开启Swagger2的自动配置
public class SwaggerConfig {
@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}
//配置文档信息
private ApiInfo apiInfo() {
Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
return new ApiInfo(
"Swagger学习", // 标题
"学习演示如何配置Swagger", // 描述
"v1.0", // 版本
"http://terms.service.url/组织链接", // 组织链接
contact, // 联系人信息
"Apach 2.0 许可", // 许可
"许可链接", // 许可连接
new ArrayList<>()// 扩展
);
}
}
(6)最重要的一点配置扫描端口,在这里有很多用法,如何扫描大家有兴趣可以去swagger的官网去看一下,或者找狂神的笔记看一下在这里还会有的最基本的!!
@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
.select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
.apis(RequestHandlerSelectors.basePackage("com.swagger.swaggerdemo1.Controller"))
.build();
}
(7)重启项目,则会在浏览器端显示出接口的各种信息!
至此swagger的初级入门已经完成了,感谢狂神,我是狂神的小迷弟!有一篇文章完结,撒花撒花!!!
更多推荐
已为社区贡献7条内容
所有评论(0)