parameters - Apiary:有没有办法定义参数的选项？

Question

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

measure = m (optional, string, 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 问题。