API Blueprintのパスにオプションのパラメータを文書化するにはどうすればよいですか？

Question

は、URLパスの中にオプションのパラメータを持っているAPIがあると仮定します。もちろん

## Get FooBar [/foo/bar/{type}] 

+ Parameters 
    + type (optional, string, `widget`) ... Filter for a specific bar type 

をtypeパラメータが実際にクエリパラメータでなければなりませんが、それはあるし、最適化することができないよう、APIの実装があります。

typeのこのオプションはURIテンプレートで表現できますか？

Answer 1

はい、オプションのパラメータを表示して、ブロックの前に疑問符を付けることができます。

## Get FooBar [/foo/bar/{?type} 

+Parameters 

    +type (optional) The widget type you want back, if any.