在swagger中創建部分

Question

我在寫一個swagger規範，我有三個單獨的端點。我如何在文檔中將它們分開？我想明確區分一個例子：用戶，文章&其他。所以每個人都會有一個CRUD描述，並在swagger UI中顯示它看起來像：

USERS 
// user specs 

POST 
// post specs 

OTHER 
// other specs 

Answer 1

您需要使用標籤來完成此操作。

因此，在你的「路徑」對象上，你排序所有的路由，並在每個路由上添加一個「標籤」：[「{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": "...", 
     } 
    }, 
} 

這不是明顯在所有的文檔。實際上文檔非常完整，但缺少索引和一些組織。