Blog

JSON形式のデータを返すAPI

2014.11.05Cat:PHP プログラマー

json_encode関数を用いることで、JSON形式のデータを簡単に生成できます。

APIを作成するにあたって、ブラウザから直接アクセスすることによって意図しない動作を引き起こすことがないように、適切に処理する必要があります。
以下サンプルでは、ブラウザ直アクセスの場合エラーになるようにしています。

json.php

このサンプルでいくつかポイントがあり、JSONを出力するスクリプトでは以下の項目を必ず実施します。
1. リクエストヘッダーにX_REQUESTED_WITHがあり、値がXMLHttpRequestであることをチェック(4~6行目)
2. Content-Typeヘッダーは、「application/json; charset=UTF-8」と正しく指定する。(17行目)
3. 「X-Content-Type-Options: nosniff」ヘッダーを追加する。(19行目)
4. JSONデータの適切なエスケープ処理(24行目)

json.phpに直接アクセスすると以下のように表示されます。

次にJSON形式で返されたデータをjQueryで動的に処理します。

ajax.php

アクセス後、読み込みボタンをクリックすると、json.phpのデータが表示されます。

品名 価格 注文数
台湾ラーメン 580 113
味噌ラーメン 580 72
ニンニクチャーハン 630 87

 

Author Profile

  • Launch Cart次世代ECサイト構築システム 初期月額無料
  • LaunchMovie ECに特化した動画制作サービス

Archive

ページTOPへ