蜂房：有没有办法定义参数选项？

Question

我想定义Apiary参数的选项，我目前在描述中列出它们：

• measurement = m（可选，字符串，m）...测量，例如m =米，km =千米，yd =码，mi =英里

Answer 1

您可以枚举URI查询参数的可能值，并在参数讨论中讨论它，如下所示：

+ Parameters
    + measurement = `m` (optional, string) ... measurement units

        Any discussion here...

        e.g. explanation of **values** listed bellow are.

        + Values
            + `m`
            + `mi`
            + `yd`

另请参阅Documenting query parameters with API Blueprint问题。

Answer 2

您可以在端点中定义可选参数，如下所示：

/api/data{?measurement}