格式注册表
注意事项
此注册表中格式的存在**并不**要求工具实现它。
如果工具选择实现此注册表中的任何格式,则**应**按照提供的行为实现该格式。
注册表**不应**包含两个具有相同含义的条目,除非所有条目(除一个外)都已弃用。
贡献
请提交 Pull 请求 或 Issue 来贡献或讨论注册表值。
值
为了 JSON Schema 验证 的目的,每个格式都应指定其适用的 JSON 数据类型集。在此注册表中,这些类型显示在“JSON 数据类型”列中。
值 | 描述 | JSON 数据类型 | 来源 | 已弃用 |
---|---|---|---|---|
base64url | 二进制数据编码为 URL 安全字符串,如 RFC4648 中所定义 | 字符串 | 是 | |
binary | 任何字节序列 | 字符串 | OAS | 是 |
byte | base64 编码数据,如 RFC4648 中所定义 | 字符串 | OAS | 是 |
char | 单个字符 | 字符串 | 否 | |
commonmark | commonmark 格式的文本 | 字符串 | OAS | 否 |
date-time | 日期和时间,如 date-time - RFC3339 中所定义 | 字符串 | JSON Schema | 否 |
date | 日期,如 full-date - RFC3339 中所定义 | 字符串 | JSON Schema | 否 |
decimal | 一个未指定精度和范围的定点小数 | 字符串,数字 | 否 | |
decimal128 | 一个具有 34 位有效十进制数字的十进制浮点数 | 字符串,数字 | 否 | |
double-int | 一个可以存储在 IEEE 754 双精度数中而不会损失精度的整数 | 数字 | 否 | |
double | 双精度浮点数 | 数字 | OAS | 否 |
duration | 持续时间,如 duration - RFC3339 中所定义 | 字符串 | JSON Schema | 否 |
一个电子邮件地址,如 RFC5321 中定义的 Mailbox | 字符串 | JSON Schema | 否 | |
float | 单精度浮点数 | 数字 | OAS | 否 |
hostname | 一个主机名,如 RFC1123 中所定义 | 字符串 | JSON Schema | 否 |
html | HTML 格式的文本 | 字符串 | OAS | 否 |
http-date | 日期和时间,如 HTTP-date - RFC7231 中所定义 | 字符串 | 否 | |
idn-email | 一个电子邮件地址,如 RFC6531 中定义的 Mailbox | 字符串 | JSON Schema | 否 |
idn-hostname | 一个国际化主机名,如 RFC5890 中所定义 | 字符串 | JSON Schema | 否 |
int16 | 带符号的 16 位整数 | 数字 | 否 | |
int32 | 带符号的 32 位整数 | 数字 | OAS | 否 |
int64 | 带符号的 64 位整数 | 数字,字符串 | OAS | 否 |
int8 | 带符号的 8 位整数 | 数字 | OAS | 否 |
ipv4 | 一个 IPv4 地址,如 RFC2673 中定义的 dotted-quad | 字符串 | JSON Schema | 否 |
ipv6 | 一个 IPv6 地址,如 RFC4673 中所定义 | 字符串 | JSON Schema | 否 |
iri-reference | 一个国际化资源标识符,如 RFC3987 中所定义 | 字符串 | JSON Schema | 否 |
iri | 一个国际化资源标识符,如 RFC3987 中所定义 | 字符串 | JSON Schema | 否 |
json-pointer | 一个 JSON 指针的 JSON 字符串表示形式,如 RFC6901 中所定义 | 字符串 | JSON Schema | 否 |
media-range | 一个媒体类型,如 RFC9110 中的 media-range ABNF 产生式所定义。 | 字符串 | OpenAPI | 否 |
password | 一个暗示隐藏值的字符串。 | 字符串 | OAS | 否 |
regex | 一个正则表达式,如 ECMA-262 中所定义 | 字符串 | JSON Schema | 否 |
relative-json-pointer | 一个相对 JSON 指针的 JSON 字符串表示形式,如 RFC 01 草案中所定义 | 字符串 | JSON Schema | 否 |
sf-binary | 结构化字段字节序列,如 [RFC8941] 中所定义 | 字符串 | RFC 8941 | 否 |
sf-boolean | 结构化字段布尔值,如 [RFC8941] 中所定义 | 字符串 | RFC 8941 | 否 |
sf-decimal | 结构化字段十进制数,如 [RFC8941] 中所定义 | 数字 | RFC 8941 | 否 |
sf-integer | 结构化字段整数,如 [RFC8941] 中所定义 | 数字 | RFC 8941 | 否 |
sf-string | 结构化字段字符串,如 [RFC8941] 中所定义 | 字符串 | RFC 8941 | 否 |
sf-token | 结构化字段标记,如 [RFC8941] 中所定义 | 字符串 | RFC 8941 | 否 |
time | 时间,如 full-time - RFC3339 中所定义 | 字符串 | JSON Schema | 否 |
uint8 | 无符号的 8 位整数 | 数字 | OAS | 否 |
uri-reference | 一个 URI 引用,如 RFC3986 中所定义 | 字符串 | JSON Schema | 否 |
uri-template | 一个 URI 模板,如 RFC6570 中所定义 | 字符串 | JSON Schema | 否 |
uri | 一个统一资源标识符,如 RFC3986 中所定义 | 字符串 | JSON Schema | 否 |
uuid | 一个通用唯一标识符,如 RFC4122 中所定义 | 字符串 | JSON Schema | 否 |