Swagger Editor hiển thị các "lỗi Schema: KHÔNG nên có thuộc tính bổ sung" lỗi cho một tham số đường

Question

Tôi đang sử dụng http://editor.swagger.io để thiết kế một API và tôi nhận được một lỗi mà tôi không biết làm thế nào để giải quyết:

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 

Tôi có các điểm cuối khác được xác định theo cách tương tự và không nhận được lỗi này. Tôi tự hỏi liệu mình có gặp vấn đề gì với dấu ngoặc kép hoặc dấu ngoặc đơn không rõ ràng, nhưng điều đó dường như không đúng. Google cũng dường như không cung cấp bất kỳ kết quả hữu ích nào.

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 

Bất kỳ gợi ý nào?

Answer 1

Thông báo lỗi gây hiểu lầm. Lỗi thực tế là thông số đường dẫn của bạn bị thiếu required: true. Thông số đường dẫn luôn được yêu cầu, vì vậy hãy nhớ thêm required: true vào chúng.