swagger集成bootstrap-ui并生成接口文档

最新推荐文章于 2025-07-11 13:34:02 发布

置顶

昊天02

最新推荐文章于 2025-07-11 13:34:02 发布

阅读量755

点赞数 1

CC 4.0 BY-SA版权

本文链接：https://blog.csdn.net/qq_41015193/article/details/115914819

本文档介绍了如何在Spring Boot应用中集成Swagger，并通过bootstrap-ui来替换默认UI，提升接口文档的展示效果。首先解释了Swagger对于REST API的重要性，然后详细讲述了Spring Boot集成Swagger的步骤，包括导入依赖、配置、添加测试接口。接着，文章演示了如何用bootstrap-ui替换Swagger默认界面，以及如何访问新界面。最后，讲解了如何导出HTML格式的接口文档，以便在交付时使用。

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

1. 什么是swagger

Swagger™的目标是为REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过Swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，Swagger去掉了调用服务时的很多猜测。

2. springboot集成swagger

导入jar包

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

编写swagger配置

package com.huiyi.config;


import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
class SwaggerConfig implements WebMvcConfigur