Question

我想在OpenAPI / Swagger定义中表示两条路径：

/ resourceA / {id}其中id是整数
/ resourceA / {name}其中name是一个字符串

两条路径都会产生相同的结果：检索resourceA实例但使用不同的主键。

使用以下Swagger定义：招摇：'2.0'

info:
  version: 1.0.0
  title: Template  API
  description: Template management

paths:
  /resourceA/{id}:
    get:
      parameters:
        - name: id
          in: path
          type: integer
          required: true
      responses:
        200:
          description: OK
  /resourceA/{name}:
    get:
      parameters:
        - name: name
          in: path
          type: string
          required: true
      responses:
        200:
          description: OK

两个定义之间存在大量重复，因为它们代表相同的端点，只是具有不同的路径参数名称/类型。

另外，swagger编辑器对此定义不满意，我收到以下错误：

 Swagger Error
Equivalent path already exists: /resourceA/{name}
Jump to line 19
Details
 Object
code:  "EQUIVALENT_PATH"
message:  "Equivalent path already exists: /resourceA/{name}"
 path: Array [2]
level: 900
type:  "Swagger Error"
description:  "Equivalent path already exists: /resourceA/{name}"
lineNumber: 19

我怎么能代表这一点来减少重复次数？

OpenAPI / Swagger：具有相同结构但路径参数类型不同的多个路径

0 个答案: