13

我正在编辑我正在处理的项目的一些 Apiary 文档，并且需要指出我的 API 调用之一的参数是日期时间字符串。Apiary 似乎对这个参数的格式感到窒息，所以我想知道在 Apiary 中记录这个参数的建议方法是什么。

为了演示，我从 Apiary 中获取了标准的默认文档，并修改了Choice文档以获取日期时间对象，如下所示：

## Choice [/questions/{question_id}/choices/{choice_id}/{datetime}]

+ Parameters
    + question_id: 1 (required, number) - ID of the Question in form of an integer
    + choice_id: 1 (required, number) - ID of the Choice in form of an integer
    + datetime: 2015-05-05T12:30:00 (optional, date) - The date/time (ISO8601 format) associated with this choice

最终结果是以下文本：

datetime
05-05T12:30:00 (optional, date) - The date/time (ISO8601 format) that all returned events should be greater than or equal to Example: 2015.

这显然是错误的，甚至记下示例值。破折号 ( -) 是一个特殊字符，在这里会引起悲伤。正确执行此操作的推荐方法是什么？

4

1 回答 1

26

您应该能够使用反引号作为转义序列。另请注意，没有date. 你应该使用string：

+ datetime: `2015-05-05T12:30:00` (optional, string) - The date/time (ISO8601 format) associated with this choice
于 2015-07-13T13:13:57.763 回答