丝袜哥的作用:获取项目的api,生成准确实时的接口文档
本着SpringCloud的特性,
我们将Swagger配置在common子目录的service_base子子目录下
而其他主要接口放在service子模块里
然后在guli_parent父模块和common子模块的pom.xml都添加依赖
<!--swagger3-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
在service_base模块里添加SwaggerConfig配置类
package com.lkw.servicebase;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableOpenApi
public class SwaggerConfig {
@Bean
public Docket docket(){
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.enable(true)
.groupName("这是组名")
.select()
.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
.paths(PathSelectors.any())
.build();
}
@SuppressWarnings("all")
public ApiInfo apiInfo(){
return new ApiInfo(
"这是标题",
"这是描述",
"v1.0",
"2279719702@qq.com", //开发者团队的邮箱
"lkw",
"许可证", //许可证
"http://www.baidu.com" //许可证链接
);
}
}
service(主要接口)子模块导入service_base依赖
<dependency>
<groupId>com.lkw.servicebase</groupId>
<artifactId>service_base</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
然后在我们的写好了的Controller里添加合适的注解,更多注解使用方法可以搜索Swagger注解了解
然后在启动类添加上包扫描注解(注意星号)