YAML 实践指南

直接回答

YAML 是以缩进表达结构的数据序列化语言,广泛用于配置。建议掌握空格缩进规则,优先写出 YAML 1.2 安全的取值,部署前校验,并结合语言/生态指南落地。

适用场景

适合学习 Kubernetes、CI、Compose、应用配置等实践 YAML。本页是 官方规范 之上的实践层,不是规范替代。

若只需快速语法检查,请直接使用 在线校验工具。

学习路径

  1. 基础语法
  2. YAML 1.1 与 1.2
  3. 锚点与多行字符串
  4. 速查表
  5. 进入 生态 或 语言 专题

最小示例

app:
  name: demo
  port: 8080
features:
  - logging
  - metrics

常见错误

反例:使用 Tab 缩进

app:
	name: demo

正例:仅使用空格

app:
  name: demo

相关链接

生产检查清单

  • 密钥不要明文写进 YAML。
  • 布尔优先 true/false;国家码等歧义值加引号。
  • CI 中校验,解析失败即失败构建。

为什么团队需要实践层文档

官方规范定义语言规则,但工程里更常卡住的是:缩进、布尔歧义、多文档、密钥泄漏、以及 K8s/CI 等领域 schema。YAML.cc 把「能写对、能校验、能排查」作为目标,而不是复述规范全文。

建议把本站工具用于隐私粘贴检查,把 yamllint 放进 CI,把生态 dry-run 当作发布门禁。

最小可运行配置模板

# app.yaml
service:
  name: api
  replicas: 2
  env:
    LOG_LEVEL: info
features:
  - metrics
  - tracing

用空格缩进;布尔用 true/false;需要当字符串的 yes/NO 请加引号。