logo标签列表

在Apiary中，表示输入参数为日期/时间的正确格式是什么？

apiblueprintapiary.ioapiary
14

我正在编辑我所在项目的一些Apiary文档，并需要标识其中一个API调用的参数为datetime字符串。由于Apiary似乎无法处理此参数的格式，因此我想知道在Apiary中记录此参数的建议方法。

为了演示，我使用了Apiary的标准默认文档，并修改了Choice文档以接受一个datetime对象，如下所示：

## 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.

这显然是错误的，即使直接写入示例值也是如此。破折号（-）是一个特殊字符，在这里会导致问题。应该采取什么样的推荐方法来解决这个问题？

1个回答
27
如果日期是由后端自动生成的（自动时间戳），该怎么办？ - Oleg Belousov
我不理解这个评论。原始问题是关于设计文档的，其中指定了HTTP请求或响应中应该包含什么。无论您的后端生成什么，都由您正确地描述它。它可能是字符串或数字。 - Honza Javorek
我想知道是否有一种方法可以指定一个字段为非必需，但由后端自动生成。 - Oleg Belousov
现在我已经学到了每种方法（GET，POST，PUT）都有自己的文档，这让我更加明白，“required” 在每种方法中本质上意味着不同的东西。 - Oleg Belousov
在请求中，您没有指定这些字段。在响应中，您将其标记为“必需”（始终存在）或“固定”（如果值是常量-通常不适用于时间戳），并在描述中注明该字段由服务器自动生成且只读。 - Honza Javorek
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接