如何正确定义 swagger 中的可重用 link?
How do I define reusable link in swagger correctly?
我在 Open API 3.0.0
中使用 swagger
以下是我的 Api 定义:
paths:
/offerers:
get:
summary: give all offerers back
operationId: allOfferers
description: give you all offerers back
responses:
'200':
description: oferers results
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OfferersId'
links:
GetSingleOffererById:
$ref: '#/components/links/GetSingleOffererById'
'400':
description: something went terribly wrong
/offerers/{offererId}:
parameters:
- in: path
name: offererId
schema:
$ref: '#/components/schemas/OfferersId'
required: true
get:
parameters:
- $ref: '#/components/schemas/OfferersId'
summary: give one specified offerer back
operationId: singleOfferer
description: give one offerer back. Specified by its id
responses:
'200':
description: offerers results
content:
application/json:
schema:
$ref: '#/components/schemas/Offerers'
'400':
description: something went terribly wrong
components:
schemas:
OfferersId:
type: number
example: 123
Offerers:
type: object
required:
- offererId
- name
properties:
id:
$ref: '#/components/schemas/OfferersId'
name:
type: string
example: "Mark Mustermann"
location:
type: string
example: "90449 Nürnberg"
experience:
type: string
example: "8 Jahre"
openingHours:
type: string
example: "Werktags: 10:15-18:30/tWochenende: geschlossen."
links:
GetSingleOffererById:
operationId: singleOfferer
description: the offererId in the response will be used as offererId in the request
paramters:
offererId: $reponse.body#/OfferersId
此定义的大部分内容没有错误。但是最后一节 components/links 在第 "operationId: singleOfferer" 行给我一个错误:
should NOT have additional properties additionalProperty: operationId,
paramters
所以我的问题是:
我该如何更正我的定义,以便可重用的 link 有效?
"should NOT have additional properties" Swagger 编辑器中的错误通常表示以下之一:
- 关键字拼写错误,
- syntax/structure 不正确。
在您的示例中,它是 (1) - paraMTers
应该是 paraMETers
。
我在 Open API 3.0.0
中使用 swagger以下是我的 Api 定义:
paths:
/offerers:
get:
summary: give all offerers back
operationId: allOfferers
description: give you all offerers back
responses:
'200':
description: oferers results
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OfferersId'
links:
GetSingleOffererById:
$ref: '#/components/links/GetSingleOffererById'
'400':
description: something went terribly wrong
/offerers/{offererId}:
parameters:
- in: path
name: offererId
schema:
$ref: '#/components/schemas/OfferersId'
required: true
get:
parameters:
- $ref: '#/components/schemas/OfferersId'
summary: give one specified offerer back
operationId: singleOfferer
description: give one offerer back. Specified by its id
responses:
'200':
description: offerers results
content:
application/json:
schema:
$ref: '#/components/schemas/Offerers'
'400':
description: something went terribly wrong
components:
schemas:
OfferersId:
type: number
example: 123
Offerers:
type: object
required:
- offererId
- name
properties:
id:
$ref: '#/components/schemas/OfferersId'
name:
type: string
example: "Mark Mustermann"
location:
type: string
example: "90449 Nürnberg"
experience:
type: string
example: "8 Jahre"
openingHours:
type: string
example: "Werktags: 10:15-18:30/tWochenende: geschlossen."
links:
GetSingleOffererById:
operationId: singleOfferer
description: the offererId in the response will be used as offererId in the request
paramters:
offererId: $reponse.body#/OfferersId
此定义的大部分内容没有错误。但是最后一节 components/links 在第 "operationId: singleOfferer" 行给我一个错误:
should NOT have additional properties additionalProperty: operationId, paramters
所以我的问题是: 我该如何更正我的定义,以便可重用的 link 有效?
"should NOT have additional properties" Swagger 编辑器中的错误通常表示以下之一:
- 关键字拼写错误,
- syntax/structure 不正确。
在您的示例中,它是 (1) - paraMTers
应该是 paraMETers
。