如何在OpenAPI（Swagger）中参数化API基本路径？

Question

我有这样的网址：

/id/{idnumber}/status

在此URL中，/id/{idnumber}是API基本路径，/status也是资源。

我知道OpenAPI（Swagger）允许在路径中添加参数，如下所示：

/id/{idnumber}/status

但这不是我所需要的，因为/id/{idnumber}它是基本路径，而不是重新分配路径的一部分。

有什么办法可以在基本路径中有参数吗？

paths:
  /id/{number}/status:

Answer 1

现在，使用服务器变量在OpenAPI 3.0中支持参数化的基本路径：

openapi: 3.0.0
...

servers:
  - url: https://my.api.com/id/{number}
    variables:
      number:
        default: '-1'

请注意，服务器变量必须具有default值-如果客户端不提供值，则将使用它。

有关详细信息，请参阅：

• OpenAPI 3.0规范的“ 服务器对象”和“ 服务器变量对象”部分
• swagger.io上的API服务器和基本URL

Answer 2

我认为不允许basePath变量。

对于您的情况，您不需要使用basePath. 您只需将 /id/{idnumber} 放入 URL 路径即可。例如：​

    "/pet/{petId}": {