スワッガーでセクションを作成する

Question

スガッガーの仕様を書いています.3つのエンドポイントがあります。ドキュメントでそれらをどのように区切りますか？私は例を明確に区別したい：ユーザ、投稿&その他。だから、それぞれがCRUDの説明を持ち、ぼんやりしたUIで表示されます。

USERS 
// user specs 

POST 
// post specs 

OTHER 
// other specs 

Answer 1

これを達成するには、タグを使用する必要があります。

あなたの "paths"オブジェクトでは、すべてのルートを並べ替え、それぞれに "タグ"：["{resource}"]を追加してグループ化する必要があります。例えば

：

"paths": { 
    "/users": { 
     "get": { 
      "tags": ["User"], 
      "description": "...", 
     }, 
     "post": { 
      "tags": ["User"], 
      "description": "...", 
     } 
    }, 

    "/posts": { 
     "get": { 
      "tags": ["Post"], 
      "description": "...", 
     }, 
     "post": { 
      "tags": ["Post"], 
      "description": "...", 
     } 
    }, 

    "/other": { 
     "get": { 
      "tags": ["Other"], 
      "description": "...", 
     }, 
     "post": { 
      "tags": ["Other"], 
      "description": "...", 
     } 
    }, 
} 

これは全くの文書で明らかにされていません。実際、文書は非常に完璧ですが、索引と組織がありません。