Я пишу спецификацию API, для которой хочу, чтобы функции PUT и PATCH были идентичными. Не имеет значения, получает ли API запрос PUT или PATCH. Он будет делать то же самое.
Есть ли для этого сокращенный/ссылочный синтаксис, который не позволил бы мне копировать и вставлять параметры, ответы и т. д. из определения метода PUT в определение метода PATCH?
No.
Хотя спецификация OpenAPI (fka Swagger) 2.0 поддерживает $ref в некоторых местах определения API, она не поддерживается на уровне операций. Поэтому вам нужно иметь отдельные определения для PUT и PATCH. Вы можете несколько уменьшить дублирование кода, $refing параметры и ответы внутри каждой операции.
paths:
/foo:
# If ALL operations within a path have some common parameters,
# define these params on the path level instead
# parameters:
# - $ref: '#/parameters/baz'
put:
parameters:
- $ref: '#/parameters/baz'
responses:
200:
$ref: '#/responses/Success'
default:
$ref: '#/responses/Error'
patch:
parameters:
- $ref: '#/parameters/baz'
responses:
200:
$ref: '#/responses/Success'
default:
$ref: '#/responses/Error'
parameters:
baz:
in: query
name: baz
type: string
responses:
Success:
description: Operation completed successfully
schema:
type: object
...
Error:
description: Error response
schema:
type: object
...
