スワッガー - ドキュメントに静的なオプションのサブパスセグメントを追加します。

Question

私は甘やかされて私のAPIを文書化しようとしています。
私はコレクションのすべての引用符を返す/api/quotesへのベースポイントを持っています。もう1つはランダムな一重引用符が返されるapi/quotes/randomです。

他の人と混乱しないようにするクエリパラメータ/api/quotes?random=trueを渡して、コレクションの順序をランダム化するオプションもあります。これは期待どおりに動作します。

私は

/** 
* @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' 
*/ 

これまでのところ、私はこれを持ってJSDocの/ YAML

を使用して最初のエンドポイントをまとめました。 このマニュアルでは、オプションのサブパス/ランダムを追加する方法を教えてください。
これらのエンドポイントをスワッガーでグループ化するにはどうすればよいですか？
これは安らかですか？

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' 
*/ 

そして、スイガーはルートをグループ化するために管理しました。それは安らかであれば、私はまだ

...不思議