Ссылка на несколько предопределенных определений параметров Swagger 2.0
У меня есть два параметра многократного использования, определенные в моем файле Swagger 2.0:
parameters:
cursorParam:
name: cursor
in: query
description: Pagination cursor.
required: false
type: string
limitParam:
name: limit
in: query
description: Result limiter.
required: false
type: integer
А затем в моих определениях маршрутов (в данном случае это GET) я пытаюсь ссылаться на оба варианта следующим образом:
parameters:
- $ref: '#/parameters/cursorParam'
- $ref: '#/parameters/limitParam'
Если я использую один $ref, похоже, он работает нормально (без ошибок компиляции), но если я пытаюсь использовать оба, он пугает меня:
Operation parameter already defined: undefined
at paths ▹ /users ▹ get ▹ parameters ▹ 1 ▹ name
Operation parameter already defined: undefined
at paths ▹ /authorisations ▹ get ▹ parameters ▹ 1 ▹ name
Более того, если я передам эти параметры в строке запроса и вывести req.swagger.params
Я получаю пустой объект. Что я делаю неправильно?
Вот полный SSCCE спецификации, генерирующий ту же ошибку:
swagger: "2.0"
info:
version: "0.0.1"
title: Test
# during dev, should point to your local machine
host: localhost
# basePath prefixes all resource paths
basePath: /
#
schemes:
# tip: remove http to make production-grade
- http
- https
# format of bodies a client can send (Content-Type)
consumes:
- application/json
# format of the responses to the client (Accepts)
produces:
- application/json
x-a127-config: {}
x-volos-resources: {}
paths:
/authorisations:
x-swagger-router-controller: authorizations
x-volos-authorizations: {}
x-volos-apply: {}
get:
description: Returns all authorizations. Requires administrator rights to view unfiltered results, or if authenticated, returns the authorization entity belonging to the OAuth token.
operationId: authorizationsGetAll #controller method name
parameters:
- $ref: '#/parameters/cursorParam'
- $ref: '#/parameters/limitParam'
responses:
200:
description: OK
# reusable parameters have parameter definitions
parameters:
cursorParam:
name: cursor
in: query
description: Pagination cursor passed to a BaaS collection. Note that if this parameter is present, lastAccessedTimestamp.{channelType} should not be updated.
required: false
type: string
limitParam:
name: limit
in: query
description: Result limiter to be passed to a BaaS collection.
required: false
type: integer
1 ответ
Решение
Похоже, вы используете старую версию a127. Отсутствие ссылочной поддержки во всех частях документа Swagger было недавно исправлено, поэтому обновление должно исправить это.