YAML格式校验

在线YAML格式校验工具,支持语法检查和格式化

校验结果将显示在这里...

YAML格式说明

1. 基本语法规则

  • 使用缩进表示层级关系,通常使用2个空格
  • 大小写敏感
  • 使用 # 表示注释
  • 不要使用制表符(Tab)进行缩进

2. 常见数据类型

# 字符串(可以不加引号)
name: John Doe
description: 'Hello, World'
message: "Hello, World"

# 数字
age: 25
price: 19.99

# 布尔值
is_active: true
is_deleted: false

# 空值
empty_field: null

# 日期和时间
date: 2024-03-21
datetime: 2024-03-21T10:30:00+08:00

3. 数组/列表

# 使用短横线(-)表示
fruits:
  - apple
  - banana
  - orange

# 行内数组
colors: [red, green, blue]

4. 对象/映射

# 嵌套对象
person:
  name: John Doe
  age: 25
  address:
    street: 123 Main St
    city: Boston
    country: USA

# 行内对象
point: {x: 10, y: 20}

5. 常见用途

  • 配置文件(如 Docker Compose, Kubernetes)
  • 数据序列化
  • 配置管理
  • 跨语言数据交换

6. 注意事项

  • 缩进必须一致,且只能使用空格
  • 字符串中如果包含特殊字符,需要使用引号
  • 冒号后面必须有一个空格
  • 不要混用不同的缩进方式

在线工具箱 > 开发工具 > YAML格式校验

YAML格式校验工具介绍

YAML格式校验工具用于检查YAML文件的语法是否正确并提示错误原因,还可以一键格式化。Spring Boot的application.yml、Kubernetes的部署文件、Docker Compose、GitHub Actions等配置都使用YAML,一个缩进错误就可能导致服务启动失败。

使用方法

  1. 粘贴YAML内容,或加载示例
  2. 点击校验,查看是否存在语法错误
  3. 根据提示修正错误,也可以点击格式化统一缩进

常见问题

YAML最常见的错误是什么?

缩进使用了Tab键(YAML只允许空格)、同一层级缩进不一致、冒号后面缺少空格,以及同一层级出现重复的key。

YAML和Properties有什么区别?

YAML用缩进表示层级,结构清晰,支持列表;Properties是扁平的 key=value 格式,Java生态中历史更久。两者可以互相转换。

字符串需要加引号吗?

大多数情况不需要,但如果值包含冒号、#号,或者是yes、no、on、off这类会被解析为布尔值的词,建议加上引号。

相关工具