本文介绍在SpringBoot项目中集成进Swagger2及美观友好的swagger-bootstrap-ui
1.添加swagger相关依赖
<!--swagger2-->
<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>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
2.配置
package com.myframe.common.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.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;
/**
* Swagger配置
* @author myframe
* @date 2021/7/30 16:58
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
List<Parameter> parameters = new ArrayList<Parameter>();
//如果访问需要token，将token放在请求头中
/*
ParameterBuilder ticketToken = new ParameterBuilder();
ticketToken.name("token")
.description("令牌")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(false).build();
parameters .add(ticketToken.build());
*/
return new Docket(DocumentationType.SWAGGER_2) //指定api类型为swagger2
.apiInfo(apiInfo()) //用于定义api文档汇总信息
.select()
.apis(RequestHandlerSelectors.basePackage("com.myframe")) // 指定扫描controller包
.paths(PathSelectors.any()) // 所有controller
.build()
.globalOperationParameters(parameters);
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("myframe") // 文档页标题
.contact(new Contact("myframe",null,null)) // 联系人信息
.description("myframe提供的api文档") //详细信息
.version("1.0.0") //文档版本号
.build();
}
}
3.使用
- 在Controller上使用@Api, 在方法上使用@ApiOperation
-
在对象上使用@ApiModel, 在属性上使用@ApiModelProperty
- 在不需要显示到界面上的Controller上使用@ApiIgnore
4.访问
- swagger-ui访问地址：http://localhost:7020/myframe /swagger-ui.html
前缀http://localhost:7020/myframe是我的springboot项目访问地址，在后面拼上/swagger-ui.html就可以访问了：
(可以在界面直接进行测试)
- swagger-bootstrap-ui访问地址： http://localhost:7020/myframe/doc.html
在后面拼上/doc.html就可以访问了：
(可以在界面直接进行测试)
推荐使用swagger-bootstrap-ui，界面更美观简洁
扫描关注公众号，阅读更多精彩内容
\
