Swager Editor显示路径参数的“Schema error:should NOT have additional properties”错误

Question

我正在使用http://editor.swagger.io为了设计API，我遇到了一个我不知道如何解决的错误：

Schema error at paths['/employees/{employeeId}/roles'].get.parameters[0]
should NOT have additional properties
additionalProperty: type, format, name, in, description
Jump to line 24

我以类似的方式定义了其他终结点，并且没有收到此错误。我想知道我是否对缩进或未闭合的引号有一些问题，但情况似乎并非如此。谷歌似乎也没有提供任何有用的结果。

swagger: "2.0"
info:
  description: Initial draft of the API specification
  version: '1.0'
  title: App 4.0 API
host: api.com
basePath: /v1
tags:
  - name: employees
    description: Employee management
schemes:
  - https
paths:
  /employees/{employeeId}/roles:
    get:
      tags:
        - employees
      summary: "Get a specific employee's roles"
      description: ''
      operationId: findEmployeeRoles
      produces:
        - application/json
      parameters:
        - name: employeeId   <====== Line 24
          in: path
          description: Id of employee whose roles we are fetching
          type: integer
          format: int64
      responses:
        '200':
          description: successful operation
          schema:
            type: array
            items:
              $ref: '#/definitions/Role'
        '403':
          description: No permission to see employee roles
        '404':
          description: EmployeeId not found

有什么提示吗？

Answer 1

对我来说，错误的原因是路径中缺少前导斜杠（internal/resource而不是/internal/resource）。

是的，错误消息是极其无用的。

Answer 2

也有同样的问题。我不小心混淆了< code>Swagger 2.0和< code>Openapi 3.0.x的语法。在< code>Openapi 3.0.x中，定义被重新定义为组件。在在线编辑器中，您可以点击编辑按钮

在此处阅读有关组件的更多信息。

备注：

OAS 3 是 OpenAPI 规范的最新版本。

Answer 3

错误消息具有误导性。实际错误是路径参数缺少required:true。路径参数始终是必需的，因此请记住将required:true添加到它们中。