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/{セクションID}
• http://a.b.com/docs/ {document-id}/section/{section-id} /セクション/ {セクションID}

正規表現スタイルを使用して、私はAPIの仕様では、このようなものを使用します。

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

だから、質問は次のとおりです。

1. 私が闊歩/ OpenAPIの仕様
2. で任意にネストされたリソースを表す行う方法です再帰的仕様の必要性を排除する別の方法がありますか？

Answer 1

もっと簡単なAPIデザインをお勧めします。一部の企業では、制限は最大2つのパスパラメータです。それ以上のものであれば、使いやすさに限界があります。