Spring boot 整合 Swagger使用swagger-bootstrap-ui

已于 2023-06-15 18:59:12 修改 · 1.2k 阅读

文章标签：

#spring boot #bootstrap #ui

于 2022-11-15 20:01:04 首次发布

java 专栏收录该内容

44 篇文章

订阅专栏

本文档介绍了如何在Springboot项目中集成增强版的Swagger-UI，通过添加相关依赖和配置，实现API文档的自动化生成，从而替代Postman进行接口测试。详细步骤包括pom.xml的依赖添加、yaml配置、配置类设置以及测试用例。集成后，开发者可以通过http://ip:端口/doc.html等地址访问增强版Swagger-UI，方便地查看和测试API。

Spring boot 整合 Swagger使用swagger-bootstrap-ui

前言

记录一下 Spring boot 整合增强版的 swagger-ui, 有了这个，基本可以省去postman调用了，极其方便

pom依赖和yaml配置

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

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

        <!-- swaggwe增强ui -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>
    </dependencies>

## swagger 启用配置
swagger:
  enable: true
  #  如果为true则禁用所有swagger资源
  production: false

config配置类

package com.zlv11.controller;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.beans.factory.annotation.Value;
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;

/**
 * @author lvzb
 * @date 2022/11/15  17:43
 **/
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class Swagger2Config {

    @Value("${swagger.enable}")
    Boolean swaggerEnabled;

    @Bean
    public Docket createRestApi() {
        // apis 扫描包范围
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(swaggerEnabled)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zlv11"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * API 说明，包含作者、简介、版本、host、服务URL
     */
    private ApiInfo apiInfo() {
        /**
         *  contact：作者信息
         */
        return new ApiInfoBuilder()
                .title("UDS-BACKEND-TITLE 文档")
                .description("UDS-BACKEND 文档")
                .version("1.0")
                .contact(new Contact("吕起凤", "http://www.XXX.com/", "xxx@qq.com"))
                .build();
    }

}

测试案例

controller

/**
 * @author lvzb
 * @date 2022/11/15  17:37
 **/
@Slf4j
@RestController
@Api(tags = "控制层")
@RequestMapping("/swagger")
public class SwaggerTestController {

    @PostMapping("/test")
    public EchoResponse echo(@RequestBody EchoRequest request) {
        return EchoResponse.builder().resp1("Hello world!").build();
    }
}

request

package com.zlv11.controller;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author lvzb
 * @date 2022/11/15  17:35
 **/
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
@ApiModel(description = "请求入参对象")
public class EchoRequest {
    @ApiModelProperty(value = "请求参数1", required = true)
    private String re1;
}

response

package com.zlv11.controller;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author lvzb
 * @date 2022/11/15  17:36
 **/
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
@ApiModel(description = "响应对象")
public class EchoResponse {

    @ApiModelProperty(value = "响应字段1")
    private String resp1;
}

启动后访问

访问 http://ip:端口/doc.html 即可看到增强版的 swagger-ui 文档
访问 http://ip:端口/swagger-ui.html 即可看到原生的 swagger-ui 文档
访问http://localhost:8000/swagger-ui/index.html 即可看到原生的 swagger-ui 文档(swagger-ui 3.0版本)
访问 http://ip:端口/v2/api-docs 即可看到 api的接口 json 内容，可以用于传到 yapi上直接导入生成接口文档，极其方便！