swagger - 为定义的 Swagger 路由提供备用(国际)拼写

Question

我正在研究具有端点的 swagger API 规范:

/authorizations

我也想为这个端点定义一个替代拼写(授权)。这可能吗？或者我是否需要为每个拼写定义一个单独的路由？

/authorizations:
    get:
      description: Returns a list of authorizations

Answer 1

一个可能的解决方法是定义另一个路径 $refs the original path ，这样您最终会得到相同路径的两个副本。

paths:
  /authorizations:
    get:
      description: Returns a list of authorizations
      responses:
        200:
          description: OK
  /authorisations:
    $ref: '#/paths/~1authorizations'

此技术的一个限制是您不能为这些路径设置 operationId，因为这两个路径将以相同的 ID 结束，这是不允许的。

如果您需要在路径中有不同的 operationId，您需要以通常的方式定义第二条路径(即从第一条路径复制粘贴定义)。