# Lumen8 で API 開発

早くも Lumen はバージョン 8 出ました。そろそろやらないとどんどん進んでいくので追いつくのは難しくなるかなあと思って Lumen8 で API サーバーを作ってみることにしました。

環境

PHP >= 7.3
Laravel Framework Lumen (8.2.3) (Laravel Components ^8.0)

Composer create-project (opens new window) コマンドで api-server という名前のプロジェクト作成

# プロジェクト作成
composer create-project --prefer-dist laravel/lumen api-server

# PHP development server起動
php -S localhost:8000 -t public

# Lumen php artisan 使えるコマンド一覧

Lumen は php artisan serve 使えないけど、他の便利機能は laravel と同様に使える模様

Available commands:

  • help Display help for a command
  • list List commands
  • migrate Run the database migrations

auth

  • auth:clear-resets Flush expired password reset tokens

cache

  • cache:clear Flush the application cache
  • cache:forget Remove an item from the cache
  • cache:table Create a migration for the cache database table

db

  • db:seed Seed the database with records
  • db:wipe Drop all tables, views, and types

make

  • make:migration Create a new migration file
  • make:seeder Create a new seeder class

migrate

  • migrate:fresh Drop all tables and re-run all migrations
  • migrate:install Create the migration repository
  • migrate:refresh Reset and re-run all migrations
  • migrate:reset Rollback all database migrations
  • migrate:rollback Rollback the last database migration
  • migrate:status Show the status of each migration

queue

  • queue:batches-table Create a migration for the batches database table
  • queue:failed List all of the failed queue jobs
  • queue:failed-table Create a migration for the failed queue jobs database table
  • queue:flush Flush all of the failed queue jobs
  • queue:forget Delete a failed queue job
  • queue:listen Listen to a given queue
  • queue:restart Restart queue worker daemons after their current job
  • queue:retry Retry a failed queue job
  • queue:table Create a migration for the queue jobs database table
  • queue:work Start processing jobs on the queue as a daemon

schedule

  • schedule:run Run the scheduled commands

# Config オプションはすべて env ファイルに

設定オプションは.envファイルに集中して書くようになります。laravel よりシンプルな設定

ドット記法で設定値取得

// グローバル config ヘルパー
$value = config('app.locale');
// デフォルト値設定
$local = config(['app.locale' => 'ja']);

// 設定ファイル読まれる前のライフサイクルならconfigure使う
$app->configure('app');

// env ファイル値
$debug = env('APP_DEBUG', true);

# ルーティングルール設定

すべてのルーティングルールはroutes/web.phpに書きます。

基本的な使い方

// get・post
$router->get('/', function () {
    return 'Hello World';
});
$router->post('welcome', function () {
    return ['result' => true,'message' => 'welcome'];
});

// 動的ID
$router->get('user/{id}', function ($id) {
    return 'User '.$id;
});
$router->get('posts/{postId}/comments/{commentId}', function ($postId, $commentId) {
    return [];
});

# オプションパラメタ

// オプションパラメタ /user[name] will match both /user and /username
$router->get('user[/{name}]', function ($name = null) {
    return $name;
});

# 正規表現

// 正規表現
$router->get('user/{name:[A-Za-z]+}', function ($name) {
    return $name;
});

# 名前付きルート

asを配列のキーにして名前定義

$router->get('profile', ['as' => 'profile', function () {
    //
}]);
$router->get('profile', [
    'as' => 'profile', 'uses' => 'UserController@showProfile'
]);

# 使えるメソッド一覧

// 使えるメソッド
$router->get($uri, $callback);
$router->post($uri, $callback);
$router->put($uri, $callback);
$router->patch($uri, $callback);
$router->delete($uri, $callback);
$router->options($uri, $callback);

# Middleware

登録している middleware で制限

$router->group(['middleware' => 'auth'], function () use ($router) {
    $router->get('/', function () {
        // Uses Auth Middleware
    });

    $router->get('user/profile', function () {
        // Uses Auth Middleware
    });
});

# Namespace

$router->group(['namespace' => 'Admin'], function() use ($router)
{
    // Using The "App\Http\Controllers\Admin" Namespace...

    $router->group(['namespace' => 'User'], function() use ($router) {
        // Using The "App\Http\Controllers\Admin\User" Namespace...
    });
});

# Prefixe

$router->group(['prefix' => 'admin'], function () use ($router) {
    $router->get('users', function () {
        // Matches The "/admin/users" URL
    });
});
$router->group(['prefix' => 'accounts/{accountId}'], function () use ($router) {
    $router->get('detail', function ($accountId) {
        // Matches The "/accounts/{accountId}/detail" URL
    });
});

# APP_KEY 作成

laravel では php artisan key:generateで APP_KEY 自動生成できますが、Lumen key:generate コマンドがないので手動作成します。

下記の 2 つの方法でランダムの 32 桁英数字が出力されます。

php -r "require 'vendor/autoload.php'; echo \Illuminate\Support\Str::random(32);"
# kJxAhlFSf5uSnAr3C7XreM05Esq4kN98

php -r "echo md5(uniqid()).\"\n\";"
# 5b0af285bc890daecc52458c7949a71c

出力されたランダム文字列をコピーして .env に貼り付けます。

参考Lumen Micro Framework => php artisan key:generate (opens new window)

2021-05-18
  • php
  • lumen
レンタルサーバー エックスサーバー レンタルサーバー エックスサーバー DMM fx DMM fx 開発/運用エンジニア募集プログラム 開発/運用エンジニア募集プログラム 外為ジャパンFX 新規口座開設促進 外為ジャパンFX 新規口座開設促進 eBay公式ショッピングサイト Qoo10 eBay公式ショッピングサイト Qoo10 Amazon.co.jpのカテゴリごとのページ

関連記事

php CSV データ取得は fgetcsv 使う
Laravel tinker 使って DB データベース接続とコマンド
Laravel Test についてのメモ
Laravel Log の基本設定&使い方
Exception: Class 'ZipArchive' not found
Laravel Sail で Docker 環境構築
PHP 文字列長さ・文字列の幅を取得方法
Codeigniter 画像アップロードとリサイズ
Laravel Lumen Faker 日本語設定
laravel method の基本 get post put options
Laravel schedule 設定
Class 'Imagick' not found Error
Laravel eloquent model の規約
PHP mbconvertkana 全角半角英数カナ変換
Codeigniter APPPATH BASEPATH FCPATH 各種パスと URL 取得
Laravel timestamp() auto update 有効化無効化
Lumen8 で JWT ユーザー認証
Laravel toSql パラメータ付きで出力
php Exception エラーキャッチでメール送信
Smarty HTTP URL 取得できるサーバー関数
Laravel blade foreach loop と current url
laravel session を制する
PHP empty isset is_null の違い
PHP 8 リリース新機能と変更
FlattenException deprecated
php.ini 初期設定のいろいろ
Laravel 5.1 から 8.1 にバージョンアップ
PHP 7.4 にアップグレードして使えなくなる機能
開発時によく使うゼロ埋めパディング作業まとめ
php date 日付の日数・月数差を計算
解決!phpMyAdmin テーブル構造の内容が表示されない問題
codeigniter email ライブラリでメール送信 日本語対応
Composer コマンドとオプション
爆速軽量フレームワーク codeigniter PHP 開発
nuxtjs と codeigniter で jwt システム構築
Lumen と Laravel 違い比較
HTML から PDF に変換 PHP ライブラリ mPDF の設定
twig 3 人気 PHP テンプレートエンジンがバージョンアップ
正規表現一覧 よく使う検索・置換のパターン
Apache 初期設定メモ
php 開発におけるコーディングルール・規約
Laravel Error についてのメモ
laravel に vuejs 使うための初期設定
php curl 使って クリックなしで POST 送信
allowurlinclude の設定で ftp_connect()エラー