在openapi中的两个不同路径之间共享operationId

Question

首先，我想为我的英语道歉。这不是我的错，而是西班牙的教育系统：

我刚刚开始一只openapi的迁移，我需要你的帮助。我喜欢使用不同的路径来引用相同的operationId。我举了一个例子来解释：

paths:
  "/my-path/my-resource":
    get:
      tags:
        - my-api
      operationId: getMyResource
      responses:
         ...
         [omitted]
         ...
  "/another-path/another-resource":
    get:
      tags:
        - my-api
      operationId: getMyResource
      responses:
         ...
         [omitted]
         ...

有可能吗？

非常感谢您的宝贵时间。

Answer 1

您的问题标记为openapi-generator，但似乎是关于OpenAPI规范的一般问题。

每个操作的操作ID必须是唯一的。等级库defines operationId的操作对象部分为：

用于标识操作的唯一字符串。在API中描述的所有操作中，id必须是唯一的。operationId值为case-sensitive.工具和库可以使用operationId来唯一地标识操作，因此，建议遵循通用的编程命名约定。

粗体的“区分大小写”直接取自规范，但强调了通过工具传递这些规范的一个很好的观点(这就是为什么它们必须是唯一的)。在openapi生成器中，我们使用operationId在生成的输出中定义方法或函数名称。许多语言不支持重载方法，有些甚至不支持非标准大小写(例如Go)。我们的工具将根据输出语言转换operationId，因此在这种情况下比规范更严格。如果您绝对需要重复的方法名称，并且您的目标输出支持它，您可以创建一个自定义生成器并扩展处理操作的逻辑。