在 Apiary 中表示输入参数是日期/时间的正确格式是啥?

     2023-03-30     84

关键词:

【中文标题】在 Apiary 中表示输入参数是日期/时间的正确格式是啥?【英文标题】:What is the correct format for denoting that an input parameter is a date/time in Apiary?在 Apiary 中表示输入参数是日期/时间的正确格式是什么? 【发布时间】:2015-07-09 15:20:00 【问题描述】:

我正在编辑我正在处理的项目的一些 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.

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

【问题讨论】:

【参考方案1】:

您应该将be able to use backticks 作为转义序列。另请注意there is no such type as date。你应该使用string:

+ datetime: `2015-05-05T12:30:00` (optional, string) - The date/time (ISO8601 format) associated with this choice

【讨论】:

如果日期是后端自动生成的呢? (自动时间戳) 我不明白评论。最初的问题是关于一个设计文档,其中指定了 HTTP 请求或响应中的内容。无论您的后端生成什么,正确描述它都取决于您。它可能是字符串或数字。 我基本上想知道是否有办法指定一个不需要但由支持自动生成的字段 现在我了解到每个方法(GET、POST、PUT)都有自己的文档,这对我来说更有意义,因为“必需”意味着每个方法基本上都有其他内容 在请求中,您不指定此类字段。作为回应,您会将其标记为required(始终存在)或fixed(如果该值是常量 - 通常不适用于时间戳),并且您会在描述中注意到该字段是由服务器自动生成的并且是只读的。

在 ruby​​ 中表示没有日期的时间

】在ruby​​中表示没有日期的时间【英文标题】:Representatimewithnodateinruby【发布时间】:2011-09-1515:24:56【问题描述】:有没有办法在没有附加日期的情况下在ruby​​中表示时间?我正在做一个时间跟踪应用程序,我只需要进出... 查看详情

在定义中表示 UNO 输出参数

】在定义中表示UNO输出参数【英文标题】:RepresentingUNOoutparametersindefinitions【发布时间】:2017-09-0706:27:23【问题描述】:UNOAPI支持inout和out参数——将变量传递给函数,函数修改变量,然后修改后的变量在函数外部可用。Javascript... 查看详情

如何在 javascript 中表示其他语言?

】如何在javascript中表示其他语言?【英文标题】:HowdoIrepresentotherlanguagesinjavascript?【发布时间】:2016-12-2410:20:42【问题描述】:我尝试在网站中表示文本。但是,该文本是从Perl返回的HTML结果中提取的。所以它已经是UTF-8了。英... 查看详情

java中表示当前日期的前5年内的随机日期怎么表示

参考技术Ajava表示距当前时间100天后的日期的方法是用Calader对象。核心代码如下:1、创建Calendar对象Calendarcalendar=Calendar.getInstance();2、调用add方法给当前日期增加100天calendar.add(Calendar.DATE,100);3、返回100天后的时间ret 查看详情

如何在 Python 函数结果中表示“未找到索引”

】如何在Python函数结果中表示“未找到索引”【英文标题】:Howtosignal"indexnotfound"inPythonFunctionresult【发布时间】:2014-01-3115:17:10【问题描述】:我正在编写一个小函数来返回字符串列表中第一次出现的字符串的索引,使... 查看详情

java中final用在参数中表示啥?

...tHelloServiceProxy(finalHelloServicehelloService)其中的final用在参数中表示什么?主要分两种情况:第一,用final修饰基本数据类型;第二,用final修饰引用类型。第一种情况,修饰基本类型(非引用类型)。这时参数的值在方法体内是不... 查看详情

在数据库中表示“重复事件”的最佳方式是啥?

】在数据库中表示“重复事件”的最佳方式是啥?【英文标题】:Whatisthebestwaytorepresent"RecurringEvents"indatabase?在数据库中表示“重复事件”的最佳方式是什么?【发布时间】:2010-12-0711:16:02【问题描述】:我正在尝试在C#... 查看详情

方法不能标记为@objc,因为参数3的类型不能在Objective-C中表示

】方法不能标记为@objc,因为参数3的类型不能在Objective-C中表示【英文标题】:Methodcannotbemarked@objcbecausethetypeoftheparameter3cannotberepresentedinObjective-C【发布时间】:2019-05-1707:47:54【问题描述】:我该如何解决这个问题?任何人都可... 查看详情

在向量空间模型中表示文档

】在向量空间模型中表示文档【英文标题】:Representingdocumentsinvectorspacemodel【发布时间】:2012-12-0910:18:12【问题描述】:我有一个非常基本的问题。我有两套文档,一套用于培训,一套用于测试。我想用训练文档训练一个逻辑回... 查看详情

在固定长度向量中表示文档集合的最佳方法是啥?

】在固定长度向量中表示文档集合的最佳方法是啥?【英文标题】:Whatisthebestwaytorepresentacollectionofdocumentsinafixedlengthvector?在固定长度向量中表示文档集合的最佳方法是什么?【发布时间】:2019-10-2711:14:46【问题描述】:我正在... 查看详情

在数据库中表示三选项的最佳方式是啥?

】在数据库中表示三选项的最佳方式是啥?【英文标题】:Whatisthebestwaytorepresentathree-choiceoptioninadatabase?在数据库中表示三选项的最佳方式是什么?【发布时间】:2012-07-0914:10:56【问题描述】:我有一个只能处于三种状态的对象... 查看详情

在 Katai 中表示 Double 值

】在Katai中表示Double值【英文标题】:representingDoublevaluesinKatai【发布时间】:2020-04-2704:37:19【问题描述】:我需要在我的ksy文件中读取的一些值是双精度值,我假设它是一个binary64结构。浮点数的本机数据类型不会延伸那么远。... 查看详情

如何在 Python 中表示无限数?

】如何在Python中表示无限数?【英文标题】:HowcanIrepresentaninfinitenumberinPython?【发布时间】:2011-12-0812:53:54【问题描述】:如何在python中表示无限数?无论您在程序中输入哪个数字,任何数字都不应大于这个无穷大的表示。【问... 查看详情

如何在java中表示一个空列表? [复制]

】如何在java中表示一个空列表?[复制]【英文标题】:HowdoIrepresentanemptylistinjava?[duplicate]【发布时间】:2016-11-1205:49:15【问题描述】:我有这个类的构造函数以一个字符串和一个数组列表作为参数;classFooStringide;ArrayListlist;publicTy... 查看详情

零长度数组如何在内存中表示?

】零长度数组如何在内存中表示?【英文标题】:Howisthezerolengtharrayrepresentedinmemory?【发布时间】:2015-07-1921:43:28【问题描述】:Java原语对象被映射到本机原语。所以我的问题是charvalue[]=newchar[0];是如何表示的?它是否取决于(... 查看详情

如何在结构/流程图中表示多个线程

】如何在结构/流程图中表示多个线程【英文标题】:Howdoesonerepresentmultiplethreadsinastructure/flowchart【发布时间】:2021-08-1822:06:14【问题描述】:我的任务是为我们组织的软件中的一些客户端-服务器和启动流程创建结构/流程图。我... 查看详情

如何在 MySQL 中表示树及其内容?

】如何在MySQL中表示树及其内容?【英文标题】:howtorepresenttreesandtheircontentinMySQL?【发布时间】:2011-03-3004:49:58【问题描述】:我需要能够存储这样的东西:其中绿色是template类型,灰色是fieldcontainer类型,白色是field。(也就是... 查看详情

在 Scheme (R6RS) 中表示代数数据类型构造函数的惯用方式是啥?

】在Scheme(R6RS)中表示代数数据类型构造函数的惯用方式是啥?【英文标题】:WhatistheidiomaticwaytorepresentalgebraicdatatypeconstructorsinScheme(R6RS)?在Scheme(R6RS)中表示代数数据类型构造函数的惯用方式是什么?【发布时间】:2021-07-0621:46:19... 查看详情