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

Question

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

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

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

当然type参数确实应该是一个查询参数，但是API实现就是这样，无法优化。

可以在 URI 模板中表达 type 的这种可选性吗？

Answer 1

是的，您可以显示可选参数，只需在它们的块前加上问号即可。

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

+Parameters

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

How to document optional parameters in path in API Blueprint?