Редактор Swagger показывает ошибку "Ошибка схемы: не должно иметь дополнительных свойств" для параметра path
Я использую 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
у меня есть другие конечные точки, определенные аналогичным образом, и не получают эту ошибку. Я задавался вопросом, есть ли у меня какие-то проблемы с отступами или незамкнутыми цитатами, но это, похоже, не так. Google также, похоже, не предоставил никаких полезных результатов.
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
Какие-То Намеки?
1 ответов
сообщение об ошибке вводит в заблуждение. Фактическая ошибка заключается в том, что ваш параметр Path отсутствует required: true
. Параметры пути всегда требуются, поэтому не забудьте добавить required: true
для них.