SpringBoot集成swaggerUI

最新推荐文章于 2025-02-24 12:04:44 发布

luck_gugu

最新推荐文章于 2025-02-24 12:04:44 发布

阅读量319

点赞数

分类专栏：接口自动化 Spring boot 文章标签： spring

本文链接：https://blog.youkuaiyun.com/luck_gugu/article/details/119808233

版权

接口自动化同时被 2 个专栏收录

7 篇文章

订阅专栏

Spring boot

3 篇文章

订阅专栏

本文档介绍了如何使用SwaggerUI来为你的Spring Boot应用自动生成接口文档。首先，在pom.xml文件中添加Swagger的相关依赖，然后创建Swagger配置类，通过Docket配置接口信息。在API接口和方法上添加@Api和@ApiOperation注解以提供详细描述。最后，通过http://localhost:8888/swagger-ui.html访问生成的接口文档。

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

简介：swaggerUI是一个自动生成接口文档的插件

1、在pom文件中添加

<properties>

    <swagger.version>2.7.0</swagger.version>

</properties>

<dependencies>

    <dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger2</artifactId>

        <version>${swagger.version}</version>

    </dependency>

    <dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger-ui</artifactId>

        <version>${swagger.version}</version>

    </dependency>

</dependencies>

2、新建一个swaggerUI的配置类

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;



@Configuration

@EnableSwagger2

public class SwaggerConfig {



    @Bean

    public Docket api() {

        return new Docket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo())

                .pathMapping("/")

                .select()

                .paths(PathSelectors.regex("/.*"))

                .build();

    }



    private ApiInfo apiInfo() {

        return new ApiInfoBuilder().title("我的接口文档")

                .contact(new Contact("lucky", "", "666@qq.com"))

                .description("这是我的SwaggerUI生成的接口文档")

                .version("1.0.0.0")

                .build();

    }

}

3、在接口类上添加标签