springboot整合swagger2

最新推荐文章于 2024-11-15 19:27:11 发布

xiaobai_1_

最新推荐文章于 2024-11-15 19:27:11 发布

阅读量283

点赞数

分类专栏：笔记文章标签： jar swagger2 spring boot

本文链接：https://blog.csdn.net/xiao_bai111/article/details/121563694

版权

笔记专栏收录该内容

18 篇文章 1 订阅

订阅专栏

本文详细介绍了如何在SpringBoot项目中整合Swagger2，包括添加依赖、配置WebMvc和Swagger2，以及在控制器中使用注解来生成API文档。通过步骤详解，助您快速搭建RESTful API的文档和管理工具。

摘要由CSDN通过智能技术生成

springboot项目整合swagger2
1，pom.xml

    <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>

2,项目新建config文件夹
2.1 WebMvcConfig.java

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {

    registry.addResourceHandler("swagger-ui.html")
            .addResourceLocations("classpath:/META-INF/resources/");

    registry.addResourceHandler("/webjars/**")
            .addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}

2.2 Swagger2Config.java

import com.google.common.base.Predicates;
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.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2配置信息
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket databaseApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("databaseApi")
                .apiInfo(webApiInfo())
                .select()
                //只显示api路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/sf/influxdb/.*")))
                .build();
    }

    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站-API文档")
                .description("本文档描述了网站微服务接口定义")
                .version("1.0")
                .contact(new Contact("xxxx", "", ""))
                .build();
    }

    private ApiInfo adminApiInfo(){
        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")
                .description("本文档描述了后台管理系统微服务接口定义")
                .version("1.0")
                .contact(new Contact("xxxx", "", ""))
                .build();
    }
}

3 在springboot启动文件夹下添加注解 @EnableWebMvc
4 controller代码中
@Api(tags = “xxxx”)
5 代码方法上面
@ApiOperation(value = “创建数据库”)