Создание разделов в swagger

Question

Я пишу spec swagger, и у меня есть три отдельных конечных точки. Как отделить их в моей документации? Я хочу иметь четкое различие между примером: пользователи, сообщения & прочее. Таким образом, каждый из них будут иметь описание CRUD и отображаются в пользовательском интерфейсе развязности это будет выглядеть так:

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": "...", 
     } 
    }, 
} 

Это не очевидно, вообще по документации. На самом деле документация очень полная, но отсутствует индекс и некоторая организация.