JSON書き方完全ガイド

JSON（JavaScript Object Notation）の正しい書き方を基礎から応用まで詳しく解説。初心者でも理解できる実践的なガイドです。

初心者向け 実践的 完全ガイド
プロが教える

JSON書き方のコツ

目次

1. JSONの基本概念

JSON（JavaScript Object Notation）は、軽量なデータ交換形式として広く使用されています。元々はJavaScriptのオブジェクト記法から派生しましたが、現在では言語に依存しない標準的なデータ形式として、Web API、設定ファイル、データストレージなど様々な場面で活用されています。

JSONの主な特徴は以下の通りです：

  • 人間が読みやすい - テキストベースで構造が明確
  • 軽量 - XMLと比較してデータサイズが小さい
  • 言語非依存 - ほぼ全てのプログラミング言語でサポート
  • 構造化データ - 階層的なデータ表現が可能
JSONの基本構造例
{
  "name": "田中太郎",
  "age": 30,
  "isStudent": false,
  "skills": ["JavaScript", "Python", "Java"],
  "address": {
    "city": "東京",
    "country": "日本"
  },
  "phoneNumber": null
}

2. JSON構文の基礎

JSONの構文は非常にシンプルですが、正確に理解することが重要です。以下の基本ルールを覚えましょう：

基本ルール
  • データは名前/値のペア
  • データはカンマで区切る
  • オブジェクトは{}で囲む
  • 配列は[]で囲む
  • 文字列は""で囲む
重要な注意点
  • シングルクォート不可
  • 末尾カンマ禁止
  • コメント不可
  • 関数定義不可
  • undefined不可

3. データ型の詳細

JSONでサポートされているデータ型は6種類です。それぞれの特徴と正しい書き方を詳しく見ていきましょう。

データ型 説明 例 注意点
string 文字列データ "Hello World" 必ずダブルクォートで囲む
number 数値データ 42, 3.14, -10 整数・小数・負数をサポート
boolean 真偽値 true, false 小文字で記述
null 空の値 null 小文字で記述
object オブジェクト {"key": "value"} キーは必ず文字列
array 配列 [1, 2, 3] 異なる型の混在可能
正しい例
{
  "name": "山田花子",
  "age": 25,
  "isActive": true,
  "balance": 1000.50,
  "address": null,
  "hobbies": ["読書", "映画鑑賞"],
  "profile": {
    "bio": "エンジニア",
    "experience": 3
  }
}
間違った例
{
  'name': '山田花子',        // シングルクォート
  age: 25,                  // キーにクォートなし
  isActive: True,           // 大文字のTrue
  balance: 1,000.50,        // カンマ区切り
  address: undefined,       // undefined使用
  hobbies: ["読書", "映画",], // 末尾カンマ
  // コメント                 // コメント記述
}

4. 実践的な書き方のコツ

効率的で保守性の高いJSONを書くための実践的なテクニックをご紹介します。これらのコツを覚えることで、より良いJSONデータを作成できるようになります。

1. 命名規則
  • camelCase推奨
  • 意味のある名前
  • 一貫性を保つ
  • 略語は避ける
2. 構造設計
  • 階層を浅く保つ
  • 関連データをグループ化
  • 配列の統一性
  • null値の適切な使用
3. パフォーマンス
  • 不要なデータを除外
  • 適切なデータ型選択
  • 文字列の最適化
  • 配列サイズの考慮
実践例：ユーザープロフィールAPI
改善前
{
  "usr_nm": "田中",
  "usr_age": "30",
  "usr_addr": {
    "pref": "東京",
    "city": "渋谷区",
    "zip": "150-0001"
  },
  "skills": ["js", "py", "java"],
  "exp": "5年"
}
改善後
{
  "userName": "田中太郎",
  "age": 30,
  "address": {
    "prefecture": "東京都",
    "city": "渋谷区",
    "postalCode": "150-0001"
  },
  "skills": ["JavaScript", "Python", "Java"],
  "experienceYears": 5
}

5. よくある間違いと対処法

JSON作成時によく発生する間違いとその対処法を学ぶことで、エラーを未然に防ぎ、効率的な開発を行うことができます。

よくある間違いの統計
1. 構文エラー
  • シングルクォートの使用
    'name': 'value'
    正解: "name": "value"
  • 末尾カンマ
    {"a": 1, "b": 2,}
    正解: {"a": 1, "b": 2}
  • キーのクォート忘れ
    {name: "value"}
    正解: {"name": "value"}
2. データ型エラー
  • 大文字のboolean
    "active": True
    正解: "active": true
  • undefinedの使用
    "value": undefined
    正解: "value": null
  • 数値の不正な形式
    "price": 1,000
    正解: "price": 1000

6. ベストプラクティス

プロフェッショナルなJSON設計のためのベストプラクティスをご紹介します。これらの原則に従うことで、保守性が高く、拡張しやすいJSONデータ構造を作成できます。

推奨事項
  • 一貫した命名規則の使用
  • 適切なデータ型の選択
  • 階層構造の最適化
  • バリデーションの実装
  • ドキュメント化の徹底
避けるべき事項
  • 深すぎるネスト構造
  • 意味不明な略語の使用
  • 不要なデータの含有
  • 型の不統一
  • セキュリティ情報の露出
JSON vs 他形式のパフォーマンス比較

7. 実用的なサンプル

実際の開発現場でよく使用されるJSONの実用例をご紹介します。これらのサンプルを参考に、実践的なJSONデータ構造を学びましょう。

API レスポンス例
{
  "status": "success",
  "data": {
    "users": [
      {
        "id": 1,
        "name": "田中太郎",
        "email": "zyacheng@gmail.com",
        "profile": {
          "age": 30,
          "department": "開発部",
          "skills": ["JavaScript", "Python", "React"],
          "joinDate": "2020-04-01"
        },
        "isActive": true
      },
      {
        "id": 2,
        "name": "佐藤花子",
        "email": "sato@example.com",
        "profile": {
          "age": 28,
          "department": "デザイン部",
          "skills": ["Figma", "Photoshop", "CSS"],
          "joinDate": "2021-06-15"
        },
        "isActive": true
      }
    ],
    "pagination": {
      "currentPage": 1,
      "totalPages": 5,
      "totalItems": 50,
      "itemsPerPage": 10
    }
  },
  "meta": {
    "timestamp": "2025-01-27T10:30:00Z",
    "version": "1.0",
    "requestId": "req_123456789"
  }
}
設定ファイル例
{
  "application": {
    "name": "MyWebApp",
    "version": "2.1.0",
    "environment": "production"
  },
  "database": {
    "host": "localhost",
    "port": 5432,
    "name": "myapp_db",
    "ssl": true,
    "connectionPool": {
      "min": 5,
      "max": 20,
      "timeout": 30000
    }
  },
  "cache": {
    "type": "redis",
    "host": "cache.example.com",
    "port": 6379,
    "ttl": 3600
  },
  "logging": {
    "level": "info",
    "format": "json",
    "outputs": ["console", "file"],
    "file": {
      "path": "/var/log/myapp.log",
      "maxSize": "100MB",
      "maxFiles": 5
    }
  },
  "features": {
    "authentication": true,
    "analytics": true,
    "notifications": false
  }
}

8. 便利なツールと検証方法

JSON作成・検証に役立つツールとテクニックをご紹介します。これらのツールを活用することで、より効率的にJSONを扱うことができます。

オンラインツール
エディタ拡張
  • VS Code JSON Tools
  • Sublime Text JSON
  • Atom JSON
  • IntelliJ JSON
コマンドライン
  • jq (JSON processor)
  • python -m json.tool
  • node -e "JSON.stringify"
  • curl + jq
JSON検証のベストプラクティス
開発時の検証
  • エディタのリアルタイム検証機能を活用
  • JSON Schemaによる構造検証
  • 自動テストでのJSON検証
  • CI/CDパイプラインでの検証
本番環境での対策
  • 入力データの事前検証
  • エラーハンドリングの実装
  • ログ出力による監視
  • フォールバック機能の準備

まとめ

JSONは現代のWeb開発において欠かせないデータ形式です。正しい書き方を身につけることで、効率的で保守性の高いアプリケーション開発が可能になります。

正確な構文
基本ルールを守った正確なJSON
実践的な設計
保守性を考慮した構造設計
効率的なツール活用
開発効率を向上させるツール使用