声明:
common项⽬ 新增SwaggerUI3.0依赖,parent项⽬已经声明了版本。
parent
<!--接口文档依赖-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>${springfox.boot.starter.version}</version>
</dependency>
common项⽬
<!--swagger ui接⼝⽂档依赖-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-bootstarter</artifactId>
</dependency>
SwaggerConfiguration配置类开发
@Component
@EnableOpenApi
@Data
public class SwaggerConfiguration {
@Bean
public Docket webApiDoc(){
return new
Docket(DocumentationType.OAS_30)
.groupName("⽤户端接⼝⽂档")
.pathMapping("/")
// 定义是否开启swagger,false为关
闭,可以通过变量控制,线上关闭
.enable(true)
//配置api⽂档元信息
.apiInfo(apiInfo())
// 选择哪些接⼝作为swagger的doc发布
.select()
.apis(RequestHandlerSelectors.basePackage("net.
xxx"))
//正则匹配请求路径,并分配⾄当前分组
.paths(PathSelectors.ant("/api/**"))
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("70ci电商平台")
.description("微服务接⼝⽂档")
.contact(new Contact("70ci", "https://blog.70ci.com",
"9701142@qq.com"))
.version("12")
.build();
}
AddressController配置接⼝⽂档
访问地址: http://localhost:9001/swagger-ui/index.html#/