如何在OpenAPI/Swagger中指定递归路径

Question

我想为我的Swagger API创建递归规范。这个概念似乎从the Swagger documentation缺席，所以我怀疑这是不可能的。所以我也愿意接受Swagger支持的其他解决方案。

例如，我试图创建一个类似文档的结构。每个文档都有部分，每个部分都有文本和它自己的部分。 我打算在具有API端点这样的：

• http://a.b.com/docs/ {文档ID}
• http://a.b.com/docs/ {文档ID} /节/ {段-ID}
• http://a.b.com/docs/ {文档ID}/section/{section-id}/section/{section-id}
• http://a.b.com/docs/ {document-id}/section/{section-id}/section/{section-id}/section/{section-id}

如果我是使用正则表达式的风格，我会使用类似这样的API规范：

...  
paths: 
    /docs/{document-id}: 
     get: 
      ... 
    /docs/{document-id}(/section/{section-id))+: 
     get: 
      ... 

所以问题是：

1. 如何在扬鞭/ OpenAPI的规范
2. 是代表任意嵌套资源还有一种消除递归规范需求的替代方法？

Answer 1

我推荐一个更简单的API设计。在一些公司中，限制是最多2个路径参数。还有更多，你正在推动可用性的限制。