Swagger配置

最新推荐文章于 2025-04-24 10:26:30 发布

Wang Zhuoqun

最新推荐文章于 2025-04-24 10:26:30 发布

阅读量309

点赞数

CC 4.0 BY-SA版权

分类专栏： web开发文章标签： maven java

本文链接：https://blog.youkuaiyun.com/ooeeerrtt/article/details/122935767

web开发专栏收录该内容

2 篇文章

订阅专栏

本文档介绍了如何在Spring Boot应用中集成并配置Swagger2（版本2.7.0），用于构建RESTful API的文档。通过添加Maven依赖，创建Swagger配置类，设置ApiInfo和忽略特定路径，可以轻松实现API的文档化。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、maven依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

2、Swagger配置类

package com.star.datacentercommon.config;

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * swagger-ui配置
 */
@Configuration
@EnableSwagger2
@SuppressWarnings({"all"})
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig() {

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("***API")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();

    }

    private ApiInfo webApiInfo() {

        return new ApiInfoBuilder()
                .title("****系统")
                .description("本文档描述了****系统接口定义")
                .version("1.0")
                .build();
    }
}