小桥流水78

这个屌丝很懒，什么也没留下！

热门标签

SpringBoot配置Swagger接口文档及美化增强依赖_springboot swagger 美化

作者：小桥流水78 | 2024-07-20 12:56:44

踩

springboot swagger 美化

Swagger2、Swagger-UI、Bootstrap-UI、Knife4j接口文档各个界面的对比和如何配置

一、Swagger-UI、Bootstrap-UI、Knife4j接口文档界面对比

1.fox-swagger2+swagger-ui的配置

2.fox-swagger2+bootstrap-ui的配置

3.knife4j的配置

三、访问接口文档地址

参考一、中不同接口文档的访问地址，这里以2.Bootstrap-UI的访问地址为例：

假如我后端服务器的端口号为：localhost:8090

那么接口文档的访问地址为：http://localhost:8090/doc.html

PS:如果配置Swagger后启动后端报错可以参考我这篇文章：

一、Swagger-UI、Bootstrap-UI、Knife4j接口文档界面对比

1.Swagger-UI

访问地址：http://ip:port/swagger-ui.html

2. Bootstrap-UI （个人推荐这个接口文档页面，比较简洁美观）

访问地址：http://ip:port/doc.html

3.Knife4j

访问地址：http://ip:port/doc.html

二、配置不同Swagger接口文档

那么该如何配置Swagger接口文档呢？

两个步骤：

1.导入相关依赖

2.导入配置类

1.fox-swagger2+swagger-ui的配置

先在pom.xml里面导入依赖


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

然后拷贝这个SwaggerConfig类到config包里面（可以自己新建一个config文件夹）


 
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.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
 
@Configuration
@EnableOpenApi
public class SwaggerConfig {
 
 
    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket restApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("标准接口")
                .apiInfo(apiInfo("Spring Boot中使用Swagger2构建RESTful APIs", "1.0"))
                .useDefaultResponseMessages(true)
                .forCodeGeneration(false)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxx.springboot.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://ip:port/swagger-ui.html
     *
     * @return
     */
    private ApiInfo apiInfo(String title, String version) {
        return new ApiInfoBuilder()
                .title(title)
                .description("")
                .version(version)
                .build();
    }
 
}

注意：这个代码中需要更改：

.apis(RequestHandlerSelectors.basePackage("com.xxx.springboot.controller"))

为你自己项目的controller类所在文件夹的路径

2.fox-swagger2+bootstrap-ui的配置

同理：先在pom.xml里面导入相关依赖


        <!--swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!-- swagger文档增强工具Bootstrap-UI-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

然后拷贝配置类同理也需要改为自己的controller类的路径


 
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.builders.RequestHandlerSelectors;
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;
 
/**
 * Swagger 美化页doc.html配置
 *
 * @author zxt
 * @since 1.0.0
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
 
    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket restApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("标准接口")
                .apiInfo(apiInfo("系统", "1.0"))
                .useDefaultResponseMessages(true)
                .forCodeGeneration(false)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.dormitory.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://ip:port/doc.html
     *
     * @return
     */
    private ApiInfo apiInfo(String title, String version) {
        return new ApiInfoBuilder()
                .title(title)
                .description("系统接口文档---Swagger2+Bootstrap-UI")
                .contact(new Contact("name", "url", "e-mail"))
                .version(version)
                .build();
    }
}