OWNED MEDIAウェブ制作に役立つコンテンツを発信中!

Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装)

最終更新日:2019.8.8 Update!!
前回記事「Laravelでデータベースと連携したCRUDのAPIを作成してみる(環境構築) 」ではPHPのフレームワークであるLaravelでAPIを使ってデータベースと連携させるまでの準備についてまとめていました。今回は引き続き、データベースのデータを更新するためのAPIを作成していきたいと思います。   ここではCRUDの操作に合わせてそれぞれAPIを作成しています。基本的にはどれもroutesディレクトリ配下のapi.phpファイルにある、RouteクラスにそれぞれCRUDの操作に対応するメソッドを指定し、処理を記述していく形になります。  
Read(データ取得)のAPI
まずはデータベースのデータを取得する操作のAPIになります。データを取得するにあたっては、全てのデータを一括して取得したり、条件に合わせて特定のデータに絞って取得することも可能です。   1. 全てのデータを取得する場合 全てのデータを一括して取得する場合はシンプルです。GETメソッドの中でall()関数を使うことでデータを全て取得することができます。Modelとなるクラスには対応するデータベースを指定したクラスを当て振ります。 【routes/api.php】※一部抜粋
use IlluminateHttpRequest;

Route::get("/read", function(){
 // Modelのクラスを指定
 return [
  "posts" => AppPost::all()
 ];
});
  ブラウザでAPIにアクセスし確認すると、データベースに入っている全てのデータがJSON形式で返されているのが確認できます。 Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装)   2. ID指定で個別のデータを取得する IDを指定し、そのIDを持つデータを拾ってくることも可能です。同じくGETメソッドでURLパスへのID指定と、コールバック関数にそのIDを引数に取ります。そしてwhere()関数で条件としてURLパスに入力されたIDを検知し、first()関数で条件に合うデータを1件取得する形になります。 【routes/api.php】※一部抜粋
use IlluminateHttpRequest;

Route::get("/read/{id}", function($id){
 return [
  "post" => AppPost::where("id",$id)->first(),
 ];
});
  こちらもブラウザで確認すると、指定したIDにマッチするデータが返されているのがわかります。URLには指定のIDがパスとして入っています。 Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装)   3. IDで条件にあった複数のデータを取得する 条件に合う不特定多数のデータを取得する場合も同じく、where()関数で条件を指定する形になります。ここではIDが閾値以上のものを取得する例になります。複数のデータの時はget()を使うことで取得することができます。 【routes/api.php】※一部抜粋
use IlluminateHttpRequest;

Route::get("/reads", function(){
 return [
  "post" => AppPost::where("id",">",1)->get()
 ];
});
  同じくブラウザでも条件に合うデータを取得できているのが確認できました。 Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装)    
Create(データ登録)のAPI
次はAPIを通して値をデータベースのレコードに書き込むAPIを作成していきます。ここでは下記の通り、メソッドにPOSTを使うことになります。まずModelとなるクラスには対応するデータベースを指定したクラスを当て振ります。そしてデータに合わせてrequest()関数を使い、リクエストボディの値を取得し、そのままsave()関数でデータベースに値を登録します。 【routes/api.php】※一部抜粋
use IlluminateHttpRequest;

Route::post("/create", function(){
 $post = new AppPost();
 $post->title = request()->get("title");
 $post->content = request()->get("content");
 $post->save();
 return [];
});
  上記ではリクエストボディを経由して値をデータベースに書き込みます。「Postman」などのAPI開発ツールなどで下記のようにJSON形式でPOSTメソッドを使いAPIを叩きます。Postmanについて詳しくはこちらの記事「Postmanの導入で捗るAPI開発やデバッグ」にまとめていますのでご参考に。
POST http://127.0.0.1:8000/api/create

{
 "title": "追加の投稿タイトル",
 "content": "追加の投稿コンテンツ本文です。"
}
  Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装) データベースの方を確認すると確かにリクエストボディに入れた値でレコードが書き込まれているのが確認できます。 Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装)    
Update(データ更新)のAPI
データの更新や変更などの操作はPATCHメソッドを使います。ここではIDを指定し、そのIDを持つデータに対して値の変更や更新を処理していきます。書き込みの時と同じく、リクエストボディ経由で値を更新していきます。ここでは更新対象のデータを指定する必要があるので、IDの値をURLパスと引数に取って対象のデータをfind()関数で探し出して指定しています。
Route::patch("/update/{id}", function($id){
 $post = AppPost::find($id);
 if($post) {
  $post->title = request()->get("title");
  $post->content = request()->get("content");
  $post->save();
 }
 return [];
});
  下記のようにPostmanを使って更新後の値を入れてAPIを叩きます。URLには対象のデータのIDを入れます。
PATCH http://127.0.0.1:8000/api/update/[ ID ]

{
 "title": "変更後の投稿タイトル",
 "content": "変更後の投稿コンテンツ本文です。"
}
  Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装) データベースで確認するとレコードが変更されているのがわかります。 Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装)    
Delete(データ削除)のAPI
最後はデータの削除です。ここではデータベースのレコードを丸ごと削除する例をあげています。データの更新・変更の時と同じようにIDを指定し削除するデータを探します。処理自体はシンプルで、delete()関数で対象のデータをそのまま削除する形になります。
Route::delete("/delete/{id}", function($id){
 $post = AppPost::find($id);
 if($post) {
  $post->delete();
 }
 return [];
});
  下記のようにPostmanを使ってDELETEメソッドでAPIを叩きます。先ほどとは異なりリクエストボディには何も値を入れずにそのままAPIにアクセスします。同じくURLパスには対象のデータのIDを入れておきます。
DELETE http://127.0.0.1:8000/api/delete/[ ID ]
  Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装) データベースの中では対象のレコードが削除されているのが確認できます。 Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装)  
  今回は基本的なCRUDの操作に対応したAPIのサンプルを作成してみました。実際のウェブアプリを開発する場合には、これらの処理をGUIで出来るようにフロント側も実装していく形になるかと思いますが、基本的な考え方としては同じようになります。Laravelではこのようにデータベースと連携したAPIも簡単に作れるのが人気の一つではないでしょうか。
  • はてなブックマーク
  • Pocket
  • Linkedin
  • Feedly

この記事を書いた人

Twitter

SPONSORED

    KEYWORD SEARCH

    RECENT POSTS

    合同会社デザインサプライ -DesignSupply. LLC-

    サイト制作・開発 / 各種デザイン制作 / ウェブプロモーション企画

    合同会社デザインサプライ(DesignSupply. LLC)

    Office:大阪府大阪市天王寺区清水谷町3-22
    Email:info@designsupply-web.com
    • Twitter
    • Github
    CONTACT USSCROLL TO TOP
      • Facebook
      • Twitter
      • Github
      • Instagram