Question

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

/authorizations

我也想为这个端点定义另一种拼写（授权）。这可能吗？或者我是否需要为每个拼写定义单独的路线？

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

Answer 1

Swagger目前不支持重载/别名路径定义。我不记得曾经见过这样的请求，但是您在https://github.com/wordnik/swagger-spec上打开问题并要求在将来的版本中添加对它的支持时，非常欢迎您。

Answer 2

一种可能的解决方法是定义$refs the original path的另一条路径，这样就最终得到了同一路径的两个副本。但在这种情况下，这些路径不能有operationId，因为两个路径都具有相同的ID，这是不允许的。

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

Answer 3

请参见https://github.com/OAI/OpenAPI-Specification/issues/213，其中一个建议是使用308重定向来定义“重命名”路径：

  /original-x:
    description: Redirects to the new X
    get:
      responses:
        '308':
          description: This resource has been moved
          headers:
            Location:
              schema:
                type: string
                default: /new-x

（我还没有看到另一种干净地实现此方法的方法。）

为定义的Swagger路由提供备用（国际）拼写

3 个答案: