Swagger 中对 Array 类型的支持允许开发者明确定义和描述 API 中涉及的数组类型参数和响应。通过指定数组元素的类型、约束和格式，开发者可以清晰地描述 API 的使用方式和预期输出。
Swagger Array 用法介绍
在 Swagger 中，你可以使用 OpenAPI 规范
定义数组参数
在 Swagger 中，你可以使用 "in" 属性将数组参数声明为路径参数、查询参数、请求体参数或响应参数。例如，如果你想定义一个名为 "ids" 的路径参数，它接受一个整数数组作为值，你可以使用以下示例：
paths:
/example/{ids}:
get:
parameters:
- in: path
name: ids
required: true
schema:
type: array
items:
type: integer在上述示例中，"schema" 属性表示参数的类型为数组，其中 "items" 属性指定了数组元素的类型为整数。
定义数组响应
类似于定义数组参数，你也可以在 Swagger 中定义 API 的响应为数组。在 OpenAPI
paths:
/users:
get:
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string在上述示例中，"schema" 属性指示响应的数据类型为数组，其中 "items" 属性定义了数组元素的类型为一个对象，并指定了该对象包含一个名为 "name" 的字符串属性。
使用数组参数或响应
在 Swagger 的请求示例和响应示例中，你可以使用具体的数组值来演示 API 的使用。例如，在请求示例中，你可以为数组参数提供一组整数值。在响应示例中，你可以提供一组对象数组作为 API 返回的示例数据。这些是 Swagger 中数组的常见用法。使用 Swagger，你可以清楚明确地定义和描述 API 的数组类型参数和响应，方便开发者理解和使用你的 API。
在 SpringBoot 项目中配置
- 添加 Swagger 依赖：在 Maven 或 Gradle 配置文件中添加 Swagger 的依赖项，以便在你的 Spring Boot 项目中使用 Swagger。Maven 的示例配置如下：
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>- 创建 Swagger 配置类：创建一个 Swagger 配置类，用于配置 Swagger 的相关信息和规范。创建一个类，并使用
@Configuration注解标记它：
@Configuration
public class SwaggerConfig {
// Swagger 配置内容
}- 配置 Swagger Docket：在 Swagger 配置类中，创建一个
DocketBean，并进行必要的配置，如 API 文档的标题、描述等。还可以使用select()方法来选择要包含在文档中的 API 接口。下面是一个示例配置：
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("API")
.select()
.apis(RequestHandlerSelectors.basePackage("com.example"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("API Documentation")
.description("API Documentation for my Spring Boot project")
.version("1.0")
.build();
}- 配置数组参数或响应：在使用 Swagger 的注解时，你可以使用数组类型来表示参数或响应。例如，在使用 @ApiOperation 注解的方法上，可以使用
@ApiParam注解来说明数组类型的参数。在使用 @ApiResponse 注解的方法上，可以使用content属性指定数组类型的响应。下面是一些示例：
@ApiOperation("Get user by IDs")
@GetMapping("/users/{ids}")
public ResponseEntity<List<User>> getUsersByIds(@ApiParam(value = "User IDs", allowMultiple = true) @PathVariable List<Long> ids) {
// API 方法实现
}
@ApiOperation("Get users")
@GetMapping("/users")
public ResponseEntity<List<User>> getUsers() {
// API 方法实现
}- 运行和访问 Swagger 文档：在完成以上配置后，你可以启动 Spring Boot 应用程序，并访问 Swagger 文档的 URL（默认为
http://localhost:8080/swagger-ui/index.html），然后你将能够查看和测试文档中包含的数组类型参数和响应。
Swagger Array 使用注意事项
在使用 Swagger Array 时，你需要注意以下事项：
- 数据类型和格式：确保正确指定数组元素的数据类型和格式。在 Swagger 中，可以使用
type指定基本数据类型，也可以使用$ref指定引用类型。确保数组中的所有元素类型与声明的类型一致。 - 参数说明：对于数组类型的参数，使用
@ApiParam注解来提供参数的详细说明。可以使用value属性来描述参数的用途和含义，使用allowMultiple属性指定是否允许传递多个值。 - 字段说明：对于数组类型的响应，可以使用
@ApiModelProperty注解或者@Schema注解来提供字段的详细说明和描述。这样可以使开发者更好地理解和使用响应中的数组类型数据。 - 可选性和必需性：使用 Swagger 注解来指示数组类型参数或响应是可选的还是必需的，以及它们的默认值。使用
required属性来指定是否为必需参数。 - 示例数据：为了更好地演示和理解数组类型的参数和响应，可以使用 Swagger 的注解提供示例数据。使用
example属性来指定示例值，或使用@Example注解提供更详细的示例数据。
Swagger 和 Apifox 整合
Swagger 管理接口有时很不方便，缺乏一定的安全性和团队间的分享协作，你可以试试 Apifox 的 IDEA 插件。你可以在 IDEA 中自动同步 Swagger 注解到 Apifox，一键生成接口文档，多端同步，非常方便测试和维护，这样就可以迅速分享 API 给其他小伙伴。
Apifox = Postman + Swagger + Mock + JMeter，Apifox 支持调试 http（s）、WebSocket、Socket、gRPC、Dubbo 等协议的接口，并且集成了 IDEA 插件。
Apifox 的 IDEA 插件可以自动解析代码注释，并基于 Javadoc、KDoc 和 ScalaDoc 生成 API 文档。通过 IntelliJ IDEA 的 Apifox Helper 插件，开发人员可以在不切换工具的情况下将他们的文档与 Apifox 项目同步。
当在 IDEA 项目中有接口信息变动，只需右键点击「 Upload to Apifox」一键即可完成同步，无需奔走相告。 团队成员可在 Apifox 中看到同步后的最新内容。
知识扩展：
参考链接
- Swagger 官方文档：https://swagger.io/docs/
- Springfox 官方文档：https://springfox.github.io/springfox/docs/current/