現在SCOUTER社では、新規事業の開発も行っており、そちらのバックエンドを開発しているのですが、そちらでは様々な手法を導入し、効率化を図っています。今回はPhpStormを使った効率化の紹介となります。 (ちなみに僕はIntelliJ IDEA派なので、PhpStormではないですが、基本的に同じことができるのでPhpStormとして紹介させていただきます。)

)

APIに必要な開発フロー

基本的に下記のフローをAPI開発で行うかと思います。

実装の記述
テストの記述、実行
データベースの確認
APIスペックの記述
GithubのPR作成

こちらすべてPhpStormで構築しているので、そちらの紹介をさせていただきます。

今回使用したプロジェクトはこちらの方に反映しています。

kotamat/phpstorm

実装の記述

まぁこちらは普通にPHPを書いていく感じなので、サラッと説明します。

PhpStormでは、型宣言している変数だけではなく、PHPDoc、assert、instanceofでのifガード下等型が明示的に推論できる箇所において補完が効いてくれます。

) )

Laravelでの開発では、基本的にDI(Dependency Injection)でのインターフェース定義をしながら環境によって実装クラスを分けるというような実装をよく行いますが、下記のようにインターフェースと実装はクリックひとつでそれぞれにジャンプすることができます。

)

テストの記述、実行

PHPUnitのテストを記述すると、メソッドとクラス定義の左側に再生ボタンが表示されます。こちらをクリックすることで、テストの実行が可能です。

また、対象メソッドやクラスのブロック内で、事前に割り当てたショートカットキーを実行すると、同様にテストを実行することができます。

)

一度実行したものは、右上の再生ボタンで再実行することができます。これはどのファイルを開いていても、最後に実行したものが実行されるため、 TDDなどテストを確認しながら実装していく開発手法を行っていると良さが実感できます。

どちらもとても良く使うので、ショートカットキーに登録して気軽に実行できるようにするとよいかと思います。

LaravelでのTDDに関しては、最近発売されたLaravel本にとてもわかり易く記述されているので、参考にしていただけるといいかなと思います。

「PHPフレームワーク Laravel Webアプリケーション開発」のご紹介 - SCOUTER開発者ブログ

データベースの確認

データベースを接続するようなテストを書く場合、実際にどのようなデータが挿入されているかを確認したいことがあるかと思います。

その際も、右側のDatabaseというところから、必要なデータソースを登録することで、テーブルの一覧から簡単にその中身を見ることができます。

)

もちろん書き込み権限のあるユーザでログインすればデータベースの中身も編集することができるため、デバッグ時に特定の条件を再現したい場合などもサクッとできてしまいます。

APIスペックの記述

今までは通常のPhpStormの使い方でしたが、下記のブログで紹介したAPIスペックの自動出力のプラグインを使うことによって、APIスペックの生成から挙動確認までPhpStormで行うことができます。

SwaggerでAPI仕様書に消耗しているなら.restを使うといい。特にLaravelなら

composer require --dev kotamat/laravel-apispec-generator

上記をインストールし、routes/api.phpをこんな感じにして、

1
2
3
4
5
<?php

Route::get('/', function () {
    return ['success' => true];
});

下記のようなテストファイルを実行すると

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<?php

namespace Tests\Feature;

use ApiSpec\ApiSpecTestCase;
use Tests\CreatesApplication;

class ExampleTest extends ApiSpecTestCase
{
    use CreatesApplication;

    protected $isExportSpec = true;

    /**
     * A basic test example.
     *
     * @return void
     */
    public function testBasicTest()
    {
        $response = $this->getJson('/api/');

        $response->assertStatus(200);
    }
}