Swagger 编辑器显示“架构错误:不应该有其他属性"；路径参数错误 [英] Swagger Editor shows the "Schema error: should NOT have additional properties" error for a path parameter

问题描述

我正在使用 http://editor.swagger.io 来设计 API，但出现错误我不知道如何解决:

I'm using http://editor.swagger.io to design an API and I get an error which I don't know how to address:

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

我有以类似方式定义的其他端点，并且没有收到此错误.我想知道缩进或未闭合的引号是否有问题，但似乎并非如此.Google 似乎也没有提供任何有用的结果.

I have other endpoints defined in a similar way, and don't get this error. I wondered if I had some issue with indentation or unclosed quotes, but that doesn't seem to be the case. Google also did not seem to provide any useful results.

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

有什么提示吗?

推荐答案

错误信息具有误导性.实际的错误是您的路径参数缺少 required: true.路径参数总是需要的，所以记得给它们加上required: true.

The error message is misleading. The actual error is that your path parameter is missing required: true. Path parameters are always required, so remember to add required: true to them.

这篇关于Swagger 编辑器显示“架构错误:不应该有其他属性"；路径参数错误的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！