如何设置路径以使用参数引用并重写名称属性？ [英] How can I setup a path to use a parameter reference and override the name property?

问题描述

我有多个路径需要ID号。有些路径需要多个ID。

我知道在构建路径时可以引用参数。

paths:
  /path1/{path1ID}
    parameters:
      - $ref: '#/components/parameters/path1ID_param'

components:
  parameters:
    path1ID_param:
      name: path1ID
      in: path
        schema:
          type: integer

如果我这样做，我会有很多重复的定义，其中唯一的变化是名称。这太刺耳了。

有什么方法可以覆盖路径定义中的名称吗？我已经尝试了allOf的各种版本，但还没有发现任何东西。我已经搜索了swagger文档，但没有太多运气。我在这里搜索过，发现了很多有趣的指针，帮助我改进了我的API……但我没有找到与我正在尝试做的事情相关的任何东西。

可以做这样的事情吗？

paths:
  /path1/{path1ID}
    parameters:
      - $ref: '#/components/parameters/parmID_param/'
      - name: path1ID
  /path1/{path1ID}/subpath2/{subpath2ID}
    - $ref: '#/components/parameters/parmID_param/'
    - name: path1ID
    - $ref: '#/components/parameters/parmID_param/'
    - name: subpath2ID

components:
  parameters:
    path1ID_param:
      name: path1ID
      in: path
        schema:
          type: integer

推荐答案

不支持此操作。

从OpenAPI 3.1开始，只能覆盖被引用参数的description，不能覆盖其name或其他属性(required、style等)。

以下是OpenAPI规范存储库中的现有功能请求：

• Extend/override properties of a parameter
• Allow required as sibling of $ref (like summary/description)

这篇关于如何设置路径以使用参数引用并重写名称属性？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！