Swagger原始类型的定义

Question

是否可以为基元类型定义招摇定义/模型？例如，考虑以下几点

definitions:
  program_name:
    type: string
    description: Unique string id

但是，上面的示例返回了许多错误（例如，swagger需要一个属性字段）并且没有示例使用任何不是类型的定义：对象。

目的是将其用作另一个模型的子组件和参数——以某种方式重用已经定义的组件。

把这想象成一个昂首阔步的typedef

编辑：根据规范，定义对象与模式对象相同http://swagger.io/specification/#schemaObject，表示它可以接受基元类型。

此外，假设基本类型可以存在于定义部分中，简单参数类型（查询、路径等）可以引用基本定义类型吗？

Answer 1

在您的示例中，基本模式是有效的，可以在任何需要模式对象的情况下使用，例如，作为另一个模式的子组件：

definitions:
  Program:
    type: object
    properties:
      program_name:
        $ref: "#/definitions/program_name"

  # This becomes:
  # type: object
  # properties:
  #   program_name:
  #     type: string
  #     description: Unique string id

或作为操作体参数或响应模式：

paths:
  /something:
    post:
      summary: POSTs and returns a string
      parameters:
        - in: body
          name: program_name
          schema:
            $ref: "#/definitions/program_name"
      responses:
        "200":
           description: OK
           schema:
             $ref: "#/definitions/program_name"

然而，简单的参数-路径、查询、标题和表单-不使用模式关键字（它们使用类型），因此它们不能从定义中引用模式。

这将在下一版本OpenAPI 3.0中更改，其中模式将用于所有参数类型。