日期（Date）

生成日期的模块。

概述

生成的日期值可以进一步进行格式化和操作。Apifox 使用管道语法来简化日期处理：

日期格式化

format

使用自定义格式字符串格式化日期。

语法: {{日期值|format('格式字符串')}}

示例

业务场景举例:

formatISO

将日期格式化为 ISO 8601 格式。

示例

formatISO9075

将日期格式化为 ISO 9075 格式（类似 ISO 8601，用于数据库）。

示例

formatRFC3339

将日期格式化为 RFC 3339 格式。

示例

formatRFC7231

将日期格式化为 RFC 7231 格式（用于 HTTP 头）。

示例

日期操作

addDays

添加或减去指定的天数。

语法: {{日期值|addDays(天数)}}

示例

addWeeks

添加或减去指定的周数。

语法: {{日期值|addWeeks(周数)}}

示例

addMonths

添加或减去指定的月数。

语法: {{日期值|addMonths(月数)}}

示例

addQuarters

添加或减去指定的季度数。

语法: {{日期值|addQuarters(季度数)}}

示例

addYears

添加或减去指定的年数。

语法: {{日期值|addYears(年数)}}

示例

在 Apifox 的动态值里点击 “更多” 可以查看其他日期操作，这里不再一一列举：

时区控制

通过设置 timezone 参数，你可以轻松控制日期的时区。

示例

基本日期函数

anytime

生成一个随机日期，可以是过去也可以是未来。

参数

名称	类型	默认值	说明
refDate	字符串 \| 数字 \| 日期	`{{$date.now}}`	用作新生成日期的参考点的日期。

返回: 日期

示例

between

在给定的边界之间生成随机日期。

参数

名称	类型	默认值	说明
from	字符串 \| 数字 \| 日期		早期日期边界。
to	字符串 \| 数字 \| 日期		晚期日期边界。

返回: 日期

示例

betweens

在给定的边界之间生成随机日期。日期将按时间顺序排序返回在数组中。

参数

名称	类型	默认值	说明
count	数字 \| { min: number; max: number; }	`3`	要生成的日期数。
from	字符串 \| 数字 \| 日期		早期日期边界。
to	字符串 \| 数字 \| 日期		晚期日期边界。

返回: 日期

示例

birthdate

返回随机出生日期。默认情况下，出生日期是为 18 至 80 岁的成年人生成的。但你可以自定义 'age' 范围或 'year' 范围以生成更具体的出生日期。

参数

名称	类型	默认值	说明
refDate	字符串 \| 数字 \| 日期	`{{$date.now}}`	用作新生成日期的参考点的日期。
max	数字		要生成出生日期的最大年龄/年份/年份。
min	数字		要生成出生日期的最小年龄/年份/年份。
mode	'age' \| 'year'		`'age'` 或 `'year'`，用于根据年龄或年份范围生成出生日期。
refDate	字符串 \| 数字\| 日期	`{{$date.now}}`	用作新生成日期的参考点的日期。仅在 `mode` 为 `'age'` 时使用。

返回: 日期

示例

future

生成未来的随机日期。

参数

名称	类型	默认值	说明
refDate	字符串 \| 数字 \| 日期	`{{$date.now}}`	用作新生成日期的参考点的日期。
years	数字	`1`	日期可能在未来的年份范围。

返回: 日期

示例

month

返回随机月份名称。

参数

名称	类型	默认值	说明
abbreviated	布尔值	`false`	是否返回缩写。
context	布尔值	`false`	是否在日期上下文中返回月份名称。在默认的 `en` 语言环境中，这没有效果，但是，在其他语言环境（如 `fr` 或 `ru`）中，这可能会影响语法或大写，例如 `ru` 中的 `{ context: false }` 为 `'январь'`，`{ context: true }` 为 `'января'`。

返回: 日期

示例

past

生成过去的随机日期。

参数

名称	类型	默认值	说明
refDate	字符串 \| 数字 \| 日期	`{{$date.now}}`	用作新生成日期的参考点的日期。
years	数字	`1`	日期可能在过去的年份范围。

返回: 日期

示例

recent

生成最近的随机日期。

参数

名称	类型	默认值	说明
days	数字	`1`	日期可能在过去的天数范围。
refDate	字符串 \| 数字 \| 日期	`{{$date.now}}`	用作新生成日期的参考点的日期。

返回: 日期

示例

soon

生成不久的将来的随机日期。

参数

名称	类型	默认值	说明
days	数字	`1`	日期可能在未来的天数范围。
refDate	字符串 \| 数字 \| 日期	`{{$date.now}}`	用作新生成日期的参考点的日期。

返回: 日期

示例

timeZone

返回随机的 IANA 时区名称。

返回的时区与当前语言环境无关。

返回: 字符串

示例

weekday

返回一周中的随机日期。

参数

名称	类型	默认值	说明
abbreviated	布尔值	`false`	是否返回缩写。
context	布尔值	`false`	是否在日期上下文中返回星期几。在默认的 `en` 语言环境中，这没有效果，但是，在其他语言环境（如 `fr` 或 `ru`）中，这可能会影响语法或大写，例如 `fr` 中的 `{ context: false }` 为 `'Lundi'`，`{ context: true }` 为 `'lundi'`。

返回: 字符串

示例

日期格式化#

format#

formatISO#

formatISO9075#

formatRFC3339#

formatRFC7231#

日期操作#

addDays#

addWeeks#

addMonths#

addQuarters#

addYears#

时区控制#

基本日期函数#

anytime#

between#

betweens#

birthdate#

future#

month#

past#

recent#

soon#

timeZone#

weekday#

日期格式化

format

formatISO

formatISO9075

formatRFC3339

formatRFC7231

日期操作

addDays

addWeeks

addMonths

addQuarters

addYears

时区控制

基本日期函数

anytime

between

betweens

birthdate

future

month

past

recent

soon

timeZone

weekday