YAML 格式化

格式化和美化 YAML。注意：注释会丢失（js-yaml 限制）

关键信息

分类
转换与编码
输入类型
textarea, number, select
输出类型
text
样本覆盖
4
支持 API
Yes

概览

YAML 格式化工具是一款高效的在线 YAML 数据处理工具，支持对 YAML/YML 配置文件进行快速美化或压缩。您可以自定义缩进大小（0-8个空格），一键规范代码排版或缩减文件体积，帮助开发者和运维人员快速排查语法错误并优化配置文件结构。需要注意的是，格式化过程中原有的注释将会丢失。

适用场景

  • •编写或修改 Kubernetes、Docker Compose 等配置文件时，需要规范缩进和排版以提高可读性。
  • •复制了排版混乱、缩进不一致的 YAML 代码，需要快速修复格式并检查语法是否正确。
  • •在生产环境部署前，需要压缩 YAML 配置文件以减少文件体积和网络传输开销。

工作原理

  • •将需要处理的 YAML 文本粘贴到输入框中。
  • •选择操作模式（美化或压缩），并根据需要设置缩进大小（默认为 2 个空格）。
  • •工具将自动解析并重新生成规范的 YAML 文本，您可以直接复制或保存结果。

使用场景

Kubernetes 部署清单排版：规范 K8s Deployment 或 Service 配置文件，确保层级结构清晰易读。
CI/CD 管道配置校验：在提交 GitHub Actions 或 GitLab CI 的配置文件前进行格式化和语法检查。
配置文件体积压缩：将复杂的 application.yml 配置文件压缩，用于 API 传输或嵌入到其他紧凑型存储中。

用户案例

1. 规范 Docker Compose 配置文件

运维工程师
背景原因
运维工程师从多个项目合并了一份 Docker Compose 配置文件，由于不同开发者的编写习惯不同，导致文件缩进混乱（有的用 4 空格，有的用 2 空格），难以维护。
解决问题
需要统一将缩进调整为标准的 2 空格，并美化整体排版。
如何使用
将混乱的 Docker Compose 文本粘贴到 YAML 输入框中，设置缩进大小为 2，模式选择“美化”。
示例配置
{
  "indentSize": 2,
  "mode": "beautify"
}
效果
获得了一份缩进完全统一、结构清晰、易于阅读的 docker-compose.yml 配置文件。

2. 压缩 Spring Boot 配置文件

后端开发人员
背景原因
开发人员需要将一个本地的 application.yml 配置文件内容作为参数传递给一个自动化部署脚本，但脚本对输入字符长度有限制。
解决问题
需要在不改变配置内容的前提下，尽可能压缩 YAML 文件的体积。
如何使用
将 application.yml 的内容复制到输入框，模式选择“压缩”。
示例配置
{
  "mode": "minify"
}
效果
输出了去除所有多余空格和换行的紧凑型 YAML 文本，成功通过部署脚本的长度校验。

用 Samples 测试

yaml
YAML 示例
YAML（YAML 不是标记语言）格式示例，从简单到复杂结构
title token yaml
yaml
Kubernetes YAML 示例
完整的 Kubernetes YAML 清单文件，包含 Deployment、Service、ConfigMap、Secret、Ingress 和其他必要资源
title token yaml
yaml
分布式追踪示例
使用 Jaeger、OpenTelemetry 和其他现代可观测性工具的综合分布式追踪示例，适用于微服务架构
preferred input family yaml
yaml
Grafana 高级应用示例
全面的 Grafana 示例，涵盖高级仪表板设计、告警配置、数据源集成和插件开发
preferred input family yaml
yaml

相关专题

配置文件转换与环境差异检查工具
把 .env 解析、YAML/TOML/HCL 转换、配置片段合并和环境差异检查放到一个配置工作流专题里。
文本脱敏、高亮与展示格式化工具
在一个专题中比较文本脱敏、PII 检测、电话号码规范化、重点高亮、居中排版和 diff 格式化工具。
JSON 格式化、对比与规范化工具
在一个专题中比较 JSON 格式化、差异对比、日志审查、配置比较和数据规范化工具，适合需要让 JSON 更易读、更易审查的流程。

常见问题

为什么格式化后我的 YAML 注释不见了？

本工具基于 js-yaml 库进行解析和重构，由于该库的底层限制，格式化或压缩过程中会忽略并清除所有注释。

缩进大小支持哪些范围？

支持 0 到 8 个空格的缩进设置，默认使用标准的 2 空格缩进。

压缩模式（minify）有什么作用？

压缩模式会移除不必要的空格、换行和缩进，将 YAML 转换为最紧凑的单行或精简格式，适合传输或存储。

输入错误的 YAML 会怎么样？

如果输入的 YAML 存在语法错误，工具将无法正常解析，并会提示相应的解析错误信息以供排查。

这个工具会把我的数据上传到服务器吗？

不会。所有格式化和压缩操作均在您的浏览器本地完成，确保您的配置数据安全隐私。

API 文档

请求端点

POST /zh/api/tools/yaml-formatter

请求参数

参数名 类型 必填 描述
yamlInput textarea 是 -
indentSize number 否 -
mode select 否 -

响应格式

{
  "result": "Processed text content",
  "error": "Error message (optional)",
  "message": "Notification message (optional)",
  "metadata": {
    "key": "value"
  }
}
文本: 文本

AI MCP 文档

将此工具添加到您的 MCP 服务器配置中： 

{
  "mcpServers": {
    "elysiatools-yaml-formatter": {
      "name": "yaml-formatter",
      "description": "格式化和美化 YAML。注意：注释会丢失（js-yaml 限制）",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=yaml-formatter",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

你可以串联多个工具，比如：`https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`，最多20个。

如果遇见问题，请联系我们：[email protected]