JSONをYAMLに変換!

JSONを入力すると読みやすいYAMLに変換します!yml, Kubernetes, docker-compose, Spring application.yml 対応。
JSON
結果
 

JSONをYAMLに変換!

JSON をインデントベースの YAML に変換します。波括弧やほとんどの引用符が消えるので、設定ファイルとして手でメンテナンスしやすくなり、キーの順序は元の JSON とまったく同じに保たれます。

kubectl get -o json で取得したリソースをマニフェストに移すときや、API から受け取った設定を docker-compose.yml、application.yml、GitHub Actions のワークフローに貼り付けるときに役立ちます。

使い方

  1. JSON 欄に JSON を貼り付けます。構文が正しくないと結果に JSON parsing failed と表示されるので、必要なら先に JSON バリデーターにかけてください。
  2. 結果 で YAML を確認します。インデントはスペース2つです。
  3. それを .yml ファイルにコピーします。別のブロックの下に入れる場合はインデントの深さを調整してください。

例

入力 (JSON)
{
  "services": {
    "web": {
      "image": "nginx:1.27",
      "ports": ["8080:80"],
      "environment": { "FEATURE_FLAG": "on", "GREETING": "hello\nworld" }
    }
  }
}
出力 (YAML)
services:
  web:
    image: nginx:1.27
    ports:
      - 8080:80
    environment:
      FEATURE_FLAG: "on"
      GREETING: |-
        hello
        world

文字列の "on" は引用符が残っています。裸の on と書くと、YAML 1.1 のパーサーは真偽値の true と読んでしまうからです。GREETING は改行を含むので、各行を書かれたとおりに見せる |- ブロックで出力されています。

対応機能

  • 引用符の付け方は YAML 1.1 に従います。yes、no、on、off、y、n、~、null のような文字列や、"0777"、"1.0"、"2024-01-01" のように別の型に見えるものには引用符を付け、PyYAML(1.1)でも最新の 1.2 のパーサーでも同じ値として読まれるようにします。
  • YAML 1.1 では60進数として読まれうる 22:22 のような文字列にも引用符を付け、docker-compose のポートマッピングでよく知られたバグを避けます。
  • 複数行の文字列は |- のリテラルブロックになります。
  • 長い文字列を折り返すことはありません(行幅の制限なし)。
  • 空の配列とオブジェクトは [] と {} のまま残ります。

利用シーン

kubectl の JSON 出力からマニフェストへ

クラスターから JSON で取り出した Deployment や ConfigMap を変換し、status や metadata.uid などのフィールドを削除すれば、Git に入れられるマニフェストになります。

Spring Boot の application.yml を書く

設定サーバーやドキュメントから JSON で受け取ったプロパティのブロックが YAML の階層になるので、spring.datasource.url のようなキーを手でインデントする必要がありません。

注意点と制限

  • コメント、アンカー(&)、エイリアス(*)は生成しません。JSON で繰り返されるオブジェクトは YAML でも繰り返されます。
  • 9007199254740991 を超える整数は JavaScript の数値の限界により精度が落ちます。長い ID は JSON の段階で文字列にしておいてください。
  • 出力は単一のドキュメントです。--- で区切った複数リソースのファイルにするには、リソースごとに変換して自分でつなげてください。

よくある質問

引用符が付く文字列と付かない文字列があるのはなぜですか?

引用符を付けるのは、裸のままだと別の型として読まれてしまう値だけです。nginx:1.27 はどちらにしても文字列ですが、on、010、22:22 はパーサーによっては真偽値や数値になるので、引用符が付きます。

出力をそのまま Kubernetes に適用できますか?

構造としてはそのまま有効です。ただし kubectl get -o json の出力には status、resourceVersion、managedFields のようなサーバーが埋めるフィールドが含まれているので、適用前に削除するのがよいでしょう。

スペース4つのインデントに切り替えられますか?

オプションはなく、Kubernetes、docker-compose、GitHub Actions のドキュメント全体で使われている慣例どおり、スペース2つに固定されています。