node.js - Swagger :requestBody 不允许

Question

我正在尝试使用 swagger 定义一个 post 端点，但它不允许 requestBody 参数:

  /names/{roster}:
    get:
      #...
    post:
      x-swagger-router-controller: names
      description: Adds or removes name(s)
      operationId: manageNames
      parameters:
      - name: roster
        in: path
        description: the roster to use
        type: string
        required: true
      requestBody:
        content:
          'application/json':
            schema:
              $ref: '#/definitions/ManageNamesRequest'

当我运行 npm start 时，我得到了这个:

API Errors:

  #/paths/~1names~1{roster}/post: Additional properties not allowed: requestBody

1 error and 0 warnings

我的规范有什么问题？

Answer 1

您可能正在混合使用 OpenAPI/Swagger 2.0 和 OpenAPI 3.0 语法。您的规范似乎是 2.0，但 requestBody 关键字是 3.0 功能。在2.0中，请求体被定义为一个body参数:

paths:
  /names/{roster}:
    post:
      produces:
        - application/json
      ...
      parameters:
      - ...
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/ManageNamesRequest'

更多信息:Describing Request Body