4

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

  • 测量= m(可选,字符串,m)...测量例如m =米,km =公里,yd =码,mi =英里
4

2 回答 2

10

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

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

        Any discussion here...

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

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

另请参阅使用 API 蓝图问题记录查询参数。

于 2014-06-24T16:41:28.907 回答
1

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

/api/data{?measurement}
于 2015-02-05T15:31:48.950 回答