0%

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

Posted:2019.08.05

Laravelでデータベースと連携したCRUDのAPIを作成してみる(環境構築)

今回はPHPのフレームワークのLaravelでデータベースと連携したCRUDのAPIを作成してみたいと思います。CRUDというのは「Created(作成)」「Read(読み込み)」「Update(更新)」「Delete(削除)」というデータベースにおける基本的な操作をまとめた呼び方になります。

 

ここではLaravelで作成したAPIでデータベースを操作し、データを作成するまでの流れをまとめていきたいと思います。今回はデータベースに「SQLite」と呼ばれるものを使っています。SQLiteはファイル型のデータベースで、MySQLのようにサーバーが不要で単一のファイルを作成するだけで使うことができるので簡単に用意することができます。それでは早速進めていきましょう。

 

まずは、SQLiteのDBファイル作成を下記のコマンドで作成します。場所はLaravelのプロジェクトの中の「database」フォルダ内に作成します。

$ cd [PROJECT_NAME] database
$ touch database.sqlite

 

SQLiteファイルが作成できたら、LaravelのDB接続設定を行います。プロジェクト直下にある「.env」ファイルを下記のように編集します。SQLiteを使う場合にはとてもシンプルな設定になります。

【.env】※一部抜粋

#DB_CONNECTION=mysql
DB_CONNECTION=sqlite
#DB_HOST=127.0.0.1
#DB_PORT=3306
#DB_DATABASE=homestead
#DB_USERNAME=homestead
#DB_PASSWORD=secret

 

DBの接続設定が終わると、DBのテーブルを生成するためのマイグレーションファイル作成します。下記コマンドでマイグレーションファイル名を指定し実行すると作成されます。

$ php artisan make:migration [FILE_NAME]

 

今回は、APIのサンプルとして簡単な記事投稿を想定したものを例として作成しますので名前をposts_tableにしました。

$ php artisan make:migration posts_table

 

database/migrations配下にマイグレーションファイルが作成されます。中身を確認すると下記のようになっており、マイグレーションのクラスにはデータベースを作成するup()という関数とデータベースを削除するdown()の関数が記述されています。もちろんデフォルトでは関数内は空になっています。

【database/migrations/yyyy_mm_dd_******_posts_table.php】※一部抜粋

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class PostsTable extends Migration
{
 public function up() {

 }

 public function down() {

 }
}

 

続いて作成したマイグレーションファイルにデータベースのスキーマを定義していきます。データベース作成には「create関数」を使い、第一引数に対象のデータベース名を指定します。そして関数内には、必要なカラム名をテータ型と合わせて指定します。ちなみにtimestamps()を使うと、created_atとupdated_atのカラムが自動的に生成されます。また、データベース削除の定義も記述しておきます。

public function up() {
 Schema::create('posts', function (Blueprint $table) {
  $table->increments('id');
  $table->string('title');
  $table->string('content');
  $table->timestamps();
 });
}
public function down(){
 Schema::dropIfExists('posts');
}

 

これで下記コマンドでマイグレーションを実行すると、データベースにテーブルとカラムが作成されます。対象のマイグレーションファイルのステータスが表示されればOKです。

$ php artisan migrate
Migrating: yyyy_mm_dd_******_posts_table
Migrated: yyyy_mm_dd_******_posts_table

 

実際にデータベースの中身を確認すると、テーブルとカラムが指定した通りに作成されているのが確認できます。

Laravelでデータベースと連携したCRUDのAPIを作成してみる(環境構築)

 

また、すでに作成したマイグレーションファイルを変更した時など、マイグレーションを更新したい時は下記のコマンドを実行します。

$ php artisan migrate:fresh

 

続いてデータベースと連携させるModelを「Eloquent」と呼ばれる機能で作成していきます。app配下にModel用のファイルを作成し、下記のようにModelをクラスとして定義していきます。Modelのクラスで対象となるテーブル名を指定します。

【app/Post.php】

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
 // 対象のテーブル名を指定
 protected $table = "posts";
}

 

続いて、Seederという機能で作成したデータベースにテストデータを流し込んでいきます。database/seeds配下にある「DatabaseSeeder.php」というファイルに下記のようにデータの内容を直接記述していきます。

【database/seeds/DatabaseSeeder.php】※一部抜粋

use Illuminate\Database\Seeder;

class DatabaseSeeder extends Seeder
{
 public function run()
 {
  \App\Post::create([
   "title" => "テスト投稿タイトル1",
   "content" => "テスト投稿タイトル1の記事本文です。"
  ]);
  \App\Post::create([
   "title" => "テスト投稿タイトル2",
   "content" => "テスト投稿タイトル2の記事本文です。"
  ]);
  // $this->call(UsersTableSeeder::class);
 }
}

 

そして下記コマンドを叩くと、データベースに指定した内容のテストデータが入ります。

$ php artisan db:seed
Database seeding completed successfully.

 

実際にデータベースの中身を確認すると、確かにデータがあるのがわかります。

Laravelでデータベースと連携したCRUDのAPIを作成してみる(環境構築)

 

これでデータベースとの連携ができる準備が整いました。今回は、Laravelを使ってデータベースと連携したAPIを作成するをテーマに環境構築についてまとめています。次回記事「Laravelでデータベースと連携したCRUDのAPIを作成してみる(API実装)」は実際にデータベース内にデータを登録したり、削除するAPIを作成していきたいと思います。

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

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

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

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

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

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

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

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

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

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

CAPTCHA


ページトップへ
大阪市天王寺区のホームページ制作デザイン事務所(SOHO)DesignSupply.【デザインサプライ】