如何在API蓝图中记录路径中的可选参数？

Question

假设有一个API在URL路径中包含可选参数：

## 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.