厳密なJSONを読みやすいYAMLに変換する
JSONは正確ですが、設定スニペット、ランブック、APIドキュメント、インフラの例ではYAMLの方が読みやすいことが多いです。このコンバーターは有効なJSONをまず解析し、それから同等のYAML構造を書き出します。
生成結果はクリーンな出発点であり、YAML作成の補助ツールではありません。JSONにはコメント、アンカー、エイリアス、カスタムYAMLタグがないため、変換時にそれらは生成されません。
JSONがYAMLにどのようにマップされるか
- オブジェクトはYAMLのマッピングになります。
- 配列はYAMLのシーケンスになります。
- 文字列、数値、ブール値、nullは解析されたJSONの値のまま保持されます。
- ソースJSONの空白はデータ構造に影響しません。
入力メモ： JavaScriptのオブジェクト構文はJSONではありません。変換前にキーと文字列を引用符で囲み、コメントを削除し、末尾のカンマを取り除いてください。
出力の適した用途
- APIレスポンスのサンプルをYAMLベースのドキュメントに移動します。
- JSONフィクスチャから設定例を作成します。
- 入れ子のオブジェクトをより行指向の形式で比較する。
- コメントを手動で追加する前に、小さなYAMLスニペットを準備します。
JSONからYAMLへのFAQ
なぜJavaScriptのオブジェクト構文は失敗するのか？
パーサーはJavaScriptではなくJSONを期待します。オブジェクトのキーと文字列は引用符で囲む必要があり、コメントは許可されず、末尾のカンマは無効です。
コンバーターはYAMLのコメントやアンカーを追加しますか？
いいえ。JSONにはコメント、アンカー、エイリアスが含まれないため、生成されるYAMLは解析されたJSONデータのみを反映します。
この出力をそのまま本番の設定として使うべきですか？
まず確認してください。YAMLの構文は有効でも、コメントや環境固有の値、対象ツールのスキーマチェックが必要な場合があります。