以前一直用的Swagger2,今天搭环境的时候听说Swagger3的界面很好看,于是我就用的Swagger3搭建的,有些步骤和Swagger已经不一样了,在这里记录一下。
1.环境
- SpringBoot2.3.7.RELEASE。
- Swagger3.0.0。
2.导包
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
3.配置文件
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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableOpenApi
public class SwaggerConfig {
@Bean
public Docket webApiConfig(){
return new Docket(DocumentationType.OAS_30)
.groupName("CTFX-API")
.apiInfo(webApiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.atfwus.ctfx"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo webApiInfo(){
return new ApiInfoBuilder()
.title("CTFX平台-API文档")
.description("本文档描述了CTF平台的所有接口定义")
.version("1.0")
.contact(new Contact("ATFWUS", "atfwus.blog.csdn.net", "atfwus@qq.com"))
.termsOfServiceUrl("http://127.0.0.1:8001/")
.build();
}
}
4.访问
- 访问:localhost:8001/swagger-ui/index.html。
5.注意
- 注意导包变了。
- 注意开启Swaagger的注解变了。
- 注意默认链接变了。
- 注意配置文件中的导包不要导错了。