首页
学习
活动
专区
圈层
工具
发布

SpringBoot整合Swagger3.x

1.添加依赖

代码语言:html
复制
<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

2.自定义SwaggerConfig配置

代码语言:java
复制
public class Swagger3Config{

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * API基础信息定义(就是更新Swagger默认页面上的信息)
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger3接口文档")
                .description("文档描述:更多问题,请联系开发者")
                .contact(new Contact("蔡熙贝", "https://gitee.com/caixibei", "caixibei@139.com"))
                .version("1.0")
                .build();
    }
}

3.启动类添加@EnableOpenApi注解并打印出访问地址

代码语言:java
复制
@SpringBootApplication(scanBasePackages = "cn.jxd.caixibei")
@ComponentScan(basePackages = "cn.jxd.caixibei")
@MapperScan(basePackages = "cn.jxd.caixibei.mapper")
@EnableOpenApi
@Slf4j
public class JyglxtApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(JyglxtApplication.class, args);
        Environment environment = context.getBean(Environment.class);
        log.info("---------------------------------------------------------");
        log.info("系统访问路径:http://localhost:"+environment.getProperty("server.port")+"/jyglxt/index/");
        log.info("Swagger访问路径:http://localhost:"+environment.getProperty("server.port")+"/swagger-ui/");
        log.info("---------------------------------------------------------");
    }
}
  1. 配置文件
代码语言:yaml
复制
# swagger配置
# 开发环境打开,建议生产环境关闭
springfox:
  documentation:
    swagger-ui:
      enabled: true
下一篇
举报
领券