Swagger - добавить статический дополнительный сегмент подкаталога в документации

Question

Я пытаюсь задокументировать свой api с чванством.
У меня есть конечная точка базы до /api/quotes, которая возвращает все кавычки в коллекции, а другая - api/quotes/random, где возвращается одна случайная цитата.

Чтобы не путать кого-либо, у меня также есть возможность передать параметр запроса /api/quotes?random=true, чтобы рандомизировать заказ коллекции. Это работает так, как ожидалось.

Я зарегистрировал первую конечную точку с помощью JSDoc/YAML

/** 
* @swagger 
* /api/quotes/: 
* get: 
*  tags: 
*  - Greek mythological Quotes 
*  description: get mythological quotes 
*  produces: 
*  - application/json 
*  parameters: 
*  - name: random 
*   in: query 
*   description: "Optional param to randomize list order" 
*   type: boolean 
*  responses: 
*  200: 
*   description: list of all mythological quotes 
*   schema: 
*   $ref: '#/definitions/Quote' 
*/ 

До сих пор у меня есть это. Как добавить дополнительный факультатив/случайный код в этой документации?
Как я могу группировать конечные точки тезисов в swagger?
Это успокаивающее?

Answer 1

Фактически чванство сделало это автоматически для меня. Я только что добавил:

/** 
* @swagger 
* /api/quotes/random: 
* get: 
*  tags: 
*  - Greek mythological Quotes 
*  description: Fetch one random mythological quote 
*  produces: 
*  - application/json 
*  responses: 
*  200: 
*   description: One random mythological quote 
*   schema: 
*   $ref: '#/definitions/Quote' 
*/ 

И чванство удалось сгруппировать маршруты.

Я до сих пор интересно, если это успокоительное ...