2022年3月11日

松本

Laravelを使ってREST APIを作ってみるお話（インストール編）

プログラミング

facebook
twitter

1 今回のゴール
2 Laravelのインストール
3 データベースの設定を行う。
4 最後に

今回のゴール

今回はComposerからLaravelをインストールし、webサーバーで表示され、データベースの構築が行えるまで。

（REST APIなので本当はwebサーバーで表示される必要はないですが…）

Laravelのインストール

以前のエントリーでPHPとLaravelをWindowsにインストールしているので、そこからLaravelをインストール作業を来ないます。

インストール前に

Windows版のPHPを入れたのですが、php.iniの設定を一部変更する必要があります。

extension = php_fileinfo.dll

1	extension = php_fileinfo.dll

これを記述しておいてください
また、実際のサーバーとWindowsのPHPのバージョンはできるだけ合わせておいた方が安全です。

インストールを行う

インストールしたい場所でターミナルを開き

composer create-project laravel/laravel --prefer-dist laravel-test

1	composer create-project laravel/laravel --prefer-dist laravel-test

と入力すると自動的にlaravel-testというフォルダを生成され、Laravelをインストールしてくれます。

その後は[.env]ファイルが生成されていることを確認し、作成されたフォルダに入り、

php artisan key:generate

1	php artisan key:generate

をターミナル上から入力してください。

もし[.env]ファイルがない場合は[.env.exsample]を[.env]にコピーしてください。

フォルダのパーミッションを確認する

「/storage/logs」「/storage/framework/」内の仮想フォルダを確認し、apacheやnginxが書き込める権限に変更します。

webサーバーにアップし、確認する

https://xxxxxxxxx.xxxx/laravel-test/public/

上記の画面が表示されればOKです。お疲れ様でした。

データベースの設定を行う。

Laravelのマイグレーションを使用してテーブルなどを設定します。

環境設定にデータベース接続情報を記述する

[.env]にある項目にデータベース接続情報を記述する

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=

DB_CONNECTION=mysql

DB_HOST=127.0.0.1

DB_PORT=3306

DB_DATABASE=laravel

DB_USERNAME=root

DB_PASSWORD=

【注意】基本的に.envはサーバーに保管するのでGitやSubversionなどのファイル管理に含むかどうか気をつけましょう

元々のマイグレーションファイルは不要なので削除します。

マイグレーションファイルの作成

$ php artisan make:migration create_users_table
Created Migration: 2022_03_11_081637_create_users_table

1 2	$ php artisan make:migration create_users_table Created Migration: 2022_03_11_081637_create_users_table

「php artisan make:migration create_users_table」と入力すると「database/migrations」に新たにマイグレーションファイルが作成されます。

マイグレーションファイルの編集

<?php

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

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function (Blueprint $table) {
            $table->id();
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('users');
    }
}

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateUsersTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

Schema::create('users', function (Blueprint $table) {

$table->id();

$table->timestamps();

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('users');

}

up()関数でテーブルのクリエイト、down()関数でテーブルの削除となるので、テーブルのフィールドを変更します。

        Schema::create('users', function (Blueprint $table) {
            $table-&gt;id();
            $table-&gt;timestamps();
        });

Schema::create('users', function (Blueprint $table) {

$table->id();

$table->timestamps();

});

を

        Schema::create('users', function (Blueprint $table) {
            $table->increments('id');
            $table->date('entry_date');
            $table->string('name', 128);
            $table->timestamps();
        });

Schema::create('users', function (Blueprint $table) {

$table->increments('id');

$table->date('entry_date');

$table->string('name', 128);

$table->timestamps();

});

に変更しました。
なんとなく感覚でわかるかと思いますが、string = varchar型で、timestampsと記述すると自動的に[create_at][updated_at]をtimesampで作成してくれます。
これをテーブルごとに作成し、描きのコマンドで実行すると

$ php artisan migrate
Migrating: 2022_03_11_081637_create_users_table
Migrated:  2022_03_11_081637_create_users_table (7.14ms)

$ php artisan migrate

Migrating: 2022_03_11_081637_create_users_table

Migrated: 2022_03_11_081637_create_users_table (7.14ms)

という感じになります。
記述が間違っているとエラーになりますのでご注意ください。

phpMyAdminで見てみると

なんと簡単に作成できました。

フィールドを追加する場合

運用している上でフィールドを追加したい場合がありますが、その場合もマイグレーションで作成できます。

$ php artisan make:migration add_users_table_add_coloumns  --table=users         
Created Migration: 2022_03_11_084714_add_users_table_add_coloumns

1 2	$ php artisan make:migration add_users_table_add_coloumns --table=users Created Migration: 2022_03_11_084714_add_users_table_add_coloumns

ファイル名はわかりやすくしています。
すると先ほどと同様にマイグレーションファイルが生成されるので、以下のように編集を行います。

<?php

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

class AddUsersTableAddColoumns extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->string('email')->nullable()->after('name');
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('users', function (Blueprint $table) {
            if (Schema::hasColumn('users', 'email')){
                $table->dropColumn('email');
            }
        });
    }
}

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class AddUsersTableAddColoumns extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

Schema::table('users', function (Blueprint $table) {

$table->string('email')->nullable()->after('name');

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::table('users', function (Blueprint $table) {

if (Schema::hasColumn('users', 'email')){

$table->dropColumn('email');

}

});

}

up()関数でnameの後ろにemailを追加しています。
ちなみにdown()関数にはemailを削除する記述をしています。

これを同様に実行すると

$ php artisan migrate
Migrating: 2022_03_11_084714_add_users_table_add_coloumns
Migrated:  2022_03_11_084714_add_users_table_add_coloumns (4.36ms)

$ php artisan migrate

Migrating: 2022_03_11_084714_add_users_table_add_coloumns

Migrated: 2022_03_11_084714_add_users_table_add_coloumns (4.36ms)

となり、

nameが追加されます。

ちなみに追加したものを戻したい場合は

$ php artisan migrate:rollback
Rolling back: 2022_03_11_084714_add_users_table_add_coloumns
Rolled back:  2022_03_11_084714_add_users_table_add_coloumns (6.67ms)

$ php artisan migrate:rollback

Rolling back: 2022_03_11_084714_add_users_table_add_coloumns

Rolled back: 2022_03_11_084714_add_users_table_add_coloumns (6.67ms)

と「:rollback」をつけることで作成したファイルのdown()関数を実行します。
少しややこしいですが

2022_03_11_081637_create_users_table
2022_03_11_084714_add_users_table_add_coloumns

の順でマイグレーションを行った場合、ロールバックを行うと、まず「2」のロールバックが行われ、次にrollbackを行うと1のロールバックが行われます。

例の場合はテーブル作成→カラム追加となるので、ロールバックを行うと「カラム削除→テーブル削除」となります。（もちろんdown()関数にきちんと処理を書いている必要がありますが）

最後に

本当はxamppなどの説明を行った方がよかったかなと思いますが、とりあえずComposerからインストールして色々とできるところまで進めました。

テーブル設計は本当に楽にできるなと思う反面、レンタルサーバーなどでどこまで自由に作れるのかが少し心配な側面があります。

次回はいよいよREST APIとして実装できればいいなと思います。

執筆者：松本[ エンジニア ]

プログラミング

jQuery+PHPで大容量ファイルを分割アップロードするお話

ファイルのアップロードを行う際に注意しないといけないのが「アップロード容量」と「タイムアウト」です。どちらもサーバーの設定に関わるところでレンタルサーバーでは対処しきれないところもあり、大容量にするとそれだけアップロードに時間がかかりタイムアウトが発生しやすくなります。そこでフロント側で分割してファイルをアップし、バックエンド側で受け取った後に結合するようにするとよいでしょう注意すべき点として通常のPOSTでの送信ではないため、あらかじめそこら辺を考慮した処理が必要とな […]

2025年2月20日

スマホアプリ

お子さまの安全を守るアプリ「みまもりキッズ」をリリースしました！

お子さまが学校や習い事、遊びに出かけたあと、「ちゃんと安全に過ごしているかな？」と心配になったことはありませんか？不審者による事件が後を絶たない昨今、お子さまの安全を守るために、常に高い意識を持たれている保護者の方も多いのではないでしょうか。そんな中、親子の安心をサポートする新しいアプリ「みまもりキッズ」が登場しました！基本無料で、カンタンに使うことができます。この記事では、アプリの魅力や使い方を詳しくご紹介します。目次1 みまもりキッズは何ができるの？1.1 カン […]

2024年12月13日

WordPress

WordPressの会員限定記事配信プラグイン「Simple Analytics」をリリースしました！

WordPressのイベントカレンダープラグイン「Simple Analytics」をリリースしました！ ※この記事は2024年10月現在の情報です。目次1 Simple Analyticsとは？2 こんなお悩みにおすすめです3 Simple Analyticsでできること3.1 月別・週別アクセス数3.1.1 確認できる項目3.2 ページ別アクセス数3.3 外部サイトからのアクセス数3.4 地域・デバイス別アクセス数3.5 時間帯別アクセス数3.6 ページ毎の直帰率3. […]

2024年10月8日

株式会社8bit (エイトビット)

東京都目黒区でWebサイト制作、Webシステム開発などを行っております。
コーポレートサイトやWebサービスの企画・提案を得意としており、自社での経験を元にアイデアをカタチにするお手伝いをさせていただいております。

Web制作に関するご相談はお気軽にどうぞ

弊社に制作をご依頼いただく際の費用感をご確認いただける、
見積りシミュレーションをご用意いたしました。

Web制作、Webサービスに関する技術やノウハウを発信するコラムサイト

Laravelを使ってREST APIを作ってみるお話（インストール編）

今回のゴール

Laravelのインストール

インストール前に

インストールを行う

フォルダのパーミッションを確認する

webサーバーにアップし、確認する

データベースの設定を行う。

マイグレーションファイルの作成

マイグレーションファイルの編集

フィールドを追加する場合

最後に

関連記事

jQuery+PHPで大容量ファイルを分割アップロードするお話

お子さまの安全を守るアプリ「みまもりキッズ」をリリースしました！

WordPressの会員限定記事配信プラグイン「Simple Analytics」をリリースしました！

Web制作、Webサービスに関する技術やノウハウを発信するコラムサイト

Laravelを使ってREST APIを作ってみるお話 （インストール編）

今回のゴール

Laravelのインストール

インストール前に

インストールを行う

フォルダのパーミッションを確認する

webサーバーにアップし、確認する

データベースの設定を行う。

マイグレーションファイルの作成

マイグレーションファイルの編集

フィールドを追加する場合

最後に

関連記事

jQuery+PHPで大容量ファイルを分割アップロードするお話

お子さまの安全を守るアプリ「みまもりキッズ」をリリースしました！

WordPressの会員限定記事配信プラグイン「Simple Analytics」をリリースしました！

Laravelを使ってREST APIを作ってみるお話（インストール編）