如何在 swagger 2.0 中添加对象数组 - TypeScript

Swagger 2.0是一种API文档自动生成工具，它可以帮助开发人员快速创建API，并生成对应的API文档。在Swagger 2.0中，我们可以使用Swagger UI来查看API文档，并在其中测试和调试API。本文将介绍如何在Swagger 2.0中添加对象数组，并在TypeScript中使用它。

添加对象数组

在Swagger 2.0中，我们可以使用OpenAPI规范来定义API。为了添加对象数组，我们需要使用OpenAPI规范中的“schema”关键字，并指定数组的类型。例如，我们可以定义一个“Person”对象，并在其中添加一个“friends”属性，其类型为“array”，元素类型为“string”。

definitions:
  Person:
    type: object
    properties:
      name:
        type: string
      age:
        type: integer
      friends:
        type: array
        items:
          type: string

在TypeScript中使用对象数组

在TypeScript中使用对象数组非常简单。我们只需要在定义类型时指定数组的类型即可。例如，我们可以定义一个“Person”类型，并在其中添加一个“friends”属性：

interface Person {
  name: string;
  age: number;
  friends: string[];
}

示例代码

下面是完整的示例代码，包括在Swagger 2.0中定义对象数组和在TypeScript中使用对象数组：

swagger: "2.0"

definitions:
  Person:
    type: object
    properties:
      name:
        type: string
      age:
        type: integer
      friends:
        type: array
        items:
          type: string

paths:
  /person:
    get:
      summary: Get a person
      description: Retrieve a person by ID
      parameters:
        - name: personId
          in: query
          type: integer
          required: true
      responses:
        200:
          description: OK
          schema:
            $ref: "#/definitions/Person"
        404:
          description: Not Found

interface Person {
  name: string;
  age: number;
  friends: string[];
}

function getPersonById(personId: number): Person {
  // implementation...
  return {
    name: "John",
    age: 30,
    friends: ["Alice", "Bob", "Charlie"],
  };
}

结论

在Swagger 2.0中添加对象数组非常简单，只需要使用OpenAPI规范中的“schema”关键字，并指定数组的类型即可。在TypeScript中使用对象数组也非常简单，只需要在定义类型时指定数组的类型即可。通过这篇文章，你可以快速了解如何添加对象数组并在TypeScript中使用它。