0%

Programmingプログラミングナレッジ

Posted:2019.07.14

Laravelで基本のREST APIを使ったデータ取得を試してみる

PHPのフレームワークLaravelでは簡単にREST APIを作成することができます。今回は基本的なAPIでGETメソッドを使ったデータ取得方法のメモになります。Laravelのインストールなどについては過去記事「【macOS】Laravelのインストールとプロジェクト作成の流れ」にて詳しくまとめています。

 

Laravelではデフォルトですとプロジェクトルート直下のrouteフォルダにある「api.php」にAPIのプログラムを記述していきます。ソースコードでは下記のように記述することで、指定したURLにアクセスすると設定した値がJSON形式で返ってくるようにすることができます。

【route/api.php】

<?php

 Route::get("/data", function(){
  return [
   "message" => "hello world !!"
  ];
 });

 

get()関数の第一引数にはURLのパスを指定します。返り値には取得するデータを入れておきます。これでローカルサーバーを起動した状態で、GETメソッドとしてURL「GET http://localhost/api/設定したパス名/」にアクセスするとJSONの値として確認できます。これが基本的なAPI作成になります。

Laravelで基本のREST APIを使ったデータ取得を試してみる

 

またデフォルトでは「ドメイン/api/」のURLになっていますが、この部分は、api/Providers/RouteServiceProvider.phpにある下記の設定で変更することが可能です。prefix()にある引数を変更します。

【api/Providers/RouteServiceProvider.php】※一部抜粋

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Route;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;

class RouteServiceProvider extends ServiceProvider {
 protected function mapApiRoutes() {
  Route::prefix('api')
   ->middleware('api')
   ->namespace($this->namespace)
   ->group(base_path('routes/api.php'));
 }
}

 

 

GETメソッドでのデータ取得

先ほどのは基本形であり、レスポンスボディにJSONの値として返す形になりますが、それ以外にもレスポンスヘッダーやステータスコードも設定することができます。下記のようにresponse()関数の引数へ、それぞれ順番に、レスポンスボディ、ステータスコード、レスポンスヘッダーと設定します。

【route/api.php】

<?php

 Route::get("/data", function(){
  $responseHeaders = [
   "X-Pages" => 1
  ];
  $responseBody = [
   "person" => array(
    "性別" => "男性",
    "血液型" => "A型",
    "血液型" => "A型",
   )
  ];
  $statusCode = 201;
  return response($responseBody, $statusCode, $responseHeaders);
 });

 

ブラウザからGETメソッドでAPIのURLにアクセスすると実際に設定した内容で取得できているのが確認できます。

Laravelで基本のREST APIを使ったデータ取得を試してみる

 

 

外部APIからGETメソッドでデータ取得

このような方法を応用することで、外部APIからデータを取得することも可能です。既存のウェブサービスではいろんなAPIが用意されています。今回はWordPressの投稿記事を取得できるWP REST APIを使って、GETメソッドでAPIを使用し投稿データをJSONで取得するサンプルになります。

 

その前に外部APIを叩いてデータを取得するケースではいくつかモジュールの追加が必要になります。まずはPHPで外部APIを叩けるモジュールである「Guzzle」をインストールします。下記コマンドでLaravelのプロジェクトルートに移動し、インストールしていきます。

$ cd プロジェクトルート
$ composer require guzzlehttp/guzzle

 

そして、ドメインが異なるサーバーにある外部APIを叩く場合にはCORS制約に引っかかってしまい下記のようにエラーが出てしまいます。

Laravelで基本のREST APIを使ったデータ取得を試してみる

 

その場合にCORS対応をする場合「laravel-cors」のモジュールをインストールします。同じくcomposerから下記コマンドでインストールできます。

$ cd プロジェクトルート
$ composer require barryvdh/laravel-cors

 

実際に外部APIを叩いてデータを取得するコードは下記のようになります。CORSはミドルウェアとしてget()関数に続けて記述する形になります。

【route/api.php】

<?php

 // Guzzleモジュールのクラス読み込み
 use GuzzleHttp\Client;

 Route::get("/data", function(){
  $client = new Client();
  $sourceUrl = "https://example.com/wp-json/wp/v2/posts/";
  $responseData = $client -> request("GET", $sourceUrl);
  $responseBody = json_decode($responseData -> getBody() -> getContents(), true);
  return [
   "status" => "OK",
   "data" => $responseBody,
  ];
 })

 // CORS対応
 -> middleware(\Barryvdh\Cors\HandleCors::class);

 

GETメソッドでアクセスすると、実際のデータを確認することができました。

Laravelで基本のREST APIを使ったデータ取得を試してみる

 

CORS対応について細かな設定は、config/cors.phpの設定ファイル内にある下記の部分で指定していく形になります。

【config/cors.php】※一部抜粋

'supportsCredentials' => false,
'allowedOrigins' => ['*'],
'allowedOriginsPatterns' => [],
'allowedHeaders' => ['*'],
'allowedMethods' => ['*'],
'exposedHeaders' => [],
'maxAge' => 0,

 

今回はREST APIの具体的なサンプルとしてGETメソッドを使ったデータの取得についてまとめていますが、そのほかにもPOST、DELETEなどのメソッドでデータベースと連携したアプリケーションを作ることができます。またこちらについては別記事でまとめていきたいと思います。

author
この記事を書いた人オガワ シンヤ
FacebookTwitter

DesignSupply.代表 / ディレクター・ウェブデザイナー・フロントエンドエンジニアをやっています。「ウェブとデザインでヒト・モノ・サービスを繋げ新しい価値を生み出す」をコンセプトに日々奮闘中!制作中はチョコレートが欠かせない三十路Webクリエイター。

制作のご依頼やお問い合わせ・パートナー業務提携のご相談はこちら

デザインやウェブ制作についてのご依頼やご相談、その他お問い合わせなどもお気軽にご連絡ください。フットワークの軽さやレスポンスの早さ、また豊富な経験や知識、技術を活かした対応力といったフリーランスクリエイターの強みでクライアント様、パートナー企業様のお力になります。デザインからコーディングやWordPress実装といったウェブサイト構築はもちろん、写真撮影や動画編集、コンテンツ制作からサイト運用サポートまで一括してお任せください。

ホームページ制作のご検討やウェブ運用でお悩みの経営者様や企業のウェブ担当者様をはじめ、個人で店舗を営んでいらっしゃるオーナー様、フリーで活動されているビジネスオーナー様はもちろんのこと、リソース不足でお困りの制作会社様、またクリエイターをお探しの代理店様も大歓迎です。

コンタクトをご希望の方はお手数ですが、下記よりお問い合わせフォームのページへアクセスしていただき、必要事項を入力の上メッセージを送信してください。確認でき次第すぐに折り返しご連絡致します。

こんな記事も読まれています

コメントもお気軽にどうぞ

記事に関するご質問やご意見などありましたら下記のコメントフォームよりお気軽に投稿ください。なおメールアドレスは公開されませんのでご安心ください。また、* が付いている欄は必須項目となります。

内容に問題なければ、下記の「コメントを送信する」ボタンを押してください。

CAPTCHA


ページトップへ