Java（三）：Swagger UI 搭建

男娘i 2024-03-16 19:04 33阅读 0赞

#### Swagger UI 搭建 ####

*   *  引入依赖
     *   *  \`pom.xml\`
     *  定义\`SwaggerConfig\`类
     *   *  \`com/example/user/config/SwaggerConfig.java\`
         *  运行报错
     *  运行访问 \`http://127.0.0.1:8000/swagger-ui.html\`
     *  测试 \`Swagger\` 页面请求接口是否可用
     *   *  当访问上传接口时会出现下列报错信息
         *  运行测试

### 引入依赖 ###

#### `pom.xml` ####

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

### 定义`SwaggerConfig`类 ###

#### `com/example/user/config/SwaggerConfig.java` ####

package com.example.user.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.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
        
    
        @Bean
        public Docket createRestApi() {
        
            return new Docket(DocumentationType.SWAGGER_2)
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.example.user.controller"))
                    .paths(PathSelectors.any())
                    .build()
                    .apiInfo(new ApiInfoBuilder().title("文件模块接口").version("v1.0").build());
        }
    
    }

#### 运行报错 ####

![在这里插入图片描述][5b9d12c3942d41a0b1989c23392db183.png_pic_center]

***解决方案：`application.yml`***

spring:
      mvc:
        path match:
          matching-strategy: ant-path-matcher

### 运行访问 `http://127.0.0.1:8000/swagger-ui.html` ###

![在这里插入图片描述][7fade321359c45aeb0feb8f78f526988.png_pic_center]

### 测试 `Swagger` 页面请求接口是否可用 ###

#### 当访问上传接口时会出现下列报错信息 ####

***报错1:***

![在这里插入图片描述][66205480933944169dc08cd458de881b.png_pic_center]

![在这里插入图片描述][c847734fb6794bf2a5fdf957714e461d.png_pic_center]

/**
     * 单/多文件上传 (新增/编辑)
     *
     * @param id             文件ID
     * @param multipartFiles 文件
     * @return 文件信息
     */
    @PostMapping(value = "/upload", headers = "content-type=multipart/form-data") /* ⚠️注意⚠️ */
    public ResponseEntity<Object> upload(String id, @RequestParam("file") MultipartFile[] multipartFiles) throws IOException {
        
        if (null != id && !id.isEmpty() && multipartFiles.length > 0) {
        
            return ResponseEntity.ok(this.fileTableService.upload(id, multipartFiles[0]));
        } else {
        
            if (multipartFiles.length > 1) {
        
                return ResponseEntity.ok(this.fileTableService.upload("", multipartFiles));
            } else {
        
                return ResponseEntity.ok(this.fileTableService.upload("", multipartFiles[0]));
            }
        }
    }

***报错2***

![在这里插入图片描述][9c603e0013c043c99c22c0295d4be4a9.png_pic_center]

![在这里插入图片描述][9e49000ff8a2427d9f94f3614851b07c.png_pic_center]

/**
     * 单/多文件上传 (新增/编辑)
     *
     * @param id             文件ID
     * @param multipartFiles 文件
     * @return 文件信息
     */
    @PostMapping(value = "/upload", headers = "content-type=multipart/form-data")
    @ApiImplicitParam(required = true, name = "file", dataType = "__file", allowMultiple = true) /* ⚠️注意⚠️ */
    public ResponseEntity<Object> upload(String id, @RequestParam("file") MultipartFile[] multipartFiles) throws IOException {
        
        System.out.println(id);
        System.out.println(multipartFiles.length);
        if (null != id && !id.isEmpty() && multipartFiles.length > 0) {
        
            return ResponseEntity.ok(this.fileTableService.upload(id, multipartFiles[0]));
        } else {
        
            if (multipartFiles.length > 1) {
        
                return ResponseEntity.ok(this.fileTableService.upload("", multipartFiles));
            } else {
        
                return ResponseEntity.ok(this.fileTableService.upload("", multipartFiles[0]));
            }
        }
    }

***报错3***

> ⚠️注意：报错3与报错2一样，原因是因为`Swagger`不支持多文件数组上传传参，会使接口收不到传过来的文件，所以需要取掉`allowMultiple = true`，建议使用`Postman`等软件进行测试

/**
     * 单/多文件上传 (新增/编辑)
     *
     * @param id             文件ID
     * @param multipartFiles 文件
     * @return 文件信息
     */
    @PostMapping(value = "/upload", headers = "content-type=multipart/form-data")
    @ApiImplicitParam(required = true, name = "file", dataType = "__file") /* ⚠️注意⚠️ */
    public ResponseEntity<Object> upload(String id, @RequestParam("file") MultipartFile[] multipartFiles) throws IOException {
        
        System.out.println(id);
        System.out.println(multipartFiles.length);
        if (null != id && !id.isEmpty() && multipartFiles.length > 0) {
        
            return ResponseEntity.ok(this.fileTableService.upload(id, multipartFiles[0]));
        } else {
        
            if (multipartFiles.length > 1) {
        
                return ResponseEntity.ok(this.fileTableService.upload("", multipartFiles));
            } else {
        
                return ResponseEntity.ok(this.fileTableService.upload("", multipartFiles[0]));
            }
        }
    }

#### 运行测试 ####

![在这里插入图片描述][41f2dc6119934c4bb68eaa9922bd51a3.png_pic_center]

[5b9d12c3942d41a0b1989c23392db183.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/4f2a8e700e344d89bbf2bc843ce6fd8e.png
[7fade321359c45aeb0feb8f78f526988.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/876dd11c4a464648a4637ee766ae1b28.png
[66205480933944169dc08cd458de881b.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/eba9cdd9c68f418f80db93cefd3c1a7e.png
[c847734fb6794bf2a5fdf957714e461d.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/54399e18ed044ca482bb757e9987a225.png
[9c603e0013c043c99c22c0295d4be4a9.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/1ae4530c10fd4f85a2e61bb8645670eb.png
[9e49000ff8a2427d9f94f3614851b07c.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/76a9eeba00d040ffb0de900301706ad1.png
[41f2dc6119934c4bb68eaa9922bd51a3.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/dbe499aced2d42c2aafce720dcc398a6.png