如何在 OpenAPI (Swagger) 语法中描述嵌套的请求体？答案

【问题标题】：How to describe nested request body in OpenAPI (Swagger) syntax?如何在 OpenAPI (Swagger) 语法中描述嵌套的请求体？
【发布时间】：2020-09-27 19:24:15
【问题描述】：

我需要用 OpenAPI (Swagger) 语法描述 REST (json) api。当我需要描述嵌套的请求正文时，我一直停留在这一点上。请建议如何制作，让我们以下一个嵌套请求正文为例：

{
   "pauses" : [
     {"name" : "PAUSING_AUTO"},
     {"name" : "NO_PAUSE_CRITERIA","Min" : 15},
     {"name" : "PREVENTED_PAUSE","Min" : 5},
     {"name" : "REVERT_TO_RUN"},
     {"name" : "RUNNING"}
    ]
}

【问题讨论】：

标签： api swagger documentation openapi swagger-3.0

【解决方案1】：

以下描述可以：

pauses:
    type: "array"
    items:
      type: "object"
      required: 
        - name
      properties:
        name:
          type: "string"
        Min:
          type: "integer"

【讨论】：