# 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: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 4年前

php
lumen

Lumen8 で JWT ユーザー認証→

正規表現一覧よく使う検索・置換のパターン

よく使う正規表現、文字検索・置換をまとめてみました。...

Carbon で php date 日付の日数・月数差を計算

Laravel Carbonは、DateTimeクラスよりもシンプルで読みやすいコードを書くことがで...

Apache 初期設定メモ

LAMP環境のApache初期設定メモ...

codeigniter email ライブラリでメール送信日本語対応

codeigniterメール送信で日本語文字化け対策、改行コードとSMTP項目設定...

Codeigniter APPPATH BASEPATH FCPATH 各種パスと URL 取得

codeigniter host url取得方法と APPPATH BASEPATHの意味を紹介...

nuxtjs と codeigniter で jwt システム構築

nuxtjsとcodeigniterでシステム構築する際のメモ...

Composer コマンドとオプション

composer install updateの違い post-install-cmdとpost-u...

Codeigniter 画像アップロードとリサイズ

Codeigniter アップロード画像リサイズと回転するなど画像操作するライブラリの使い方...

爆速軽量フレームワーク codeigniter PHP 開発

ルーター設定もなく、初期設定も少ない！軽量と爆速で動いてくれるフレームワーク codeigniter...

PHP mbconvertkana 全角半角英数カナ変換

php カナコンバートなら mb_convert_kana を使う！全角半角、英数字や記号など簡単に...

開発におけるコーディングルール・規約

コーディングルールと規約を大事にする、複数人で開発しても、一人で開発してもメンテナンスやコードのわか...

php CSV データ取得は fgetcsv 使う

PHP csvアップロードしてデータインポート作業がありましたが、fgetcsv使ってcsv処理につ...

FlattenException deprecated

laravelバージョンアップ作業する際にFlattenException deprecatedにつ...

PHP empty isset is_null の違い

PHP empty, isset, is_nullの違いよく使うPHP isset と if の違...

allowurlinclude の設定で ftp_connect()エラー

FTPサーバーとやりとりする時にftp_connect()エラーが発生、PHP７にアップしたばかりで...

Class 'Imagick' not found Error

phpで画像操作したらimagickエラーで動かなくなったため、imagickモジュールをインストを...

php Exception エラーキャッチでメール送信

エラーメッセージ、エラーコード、エラー詳細取得、php例外処理exceptionのいろいろ...

Laravel blade foreach loop と current url

laravel blade foreach loop変数とurlのプロパティ対照表...

php curl 使ってクリックなしで POST 送信

PHP curl_setopt使ってシンプルにデータ転送してpost投げます。PHPは本当に短いソー...

Laravel eloquent model の規約

最新Laravel開発eloquent model設定資料まとめ...

Laravel でカテゴリー作成テーブル構築と再帰クエリ

カテゴリ関係を管理するためのテーブルを設計...

Laravel Lumen Faker 日本語設定

Laravel Faker 日本語化設定 fakerphpの使い方とよく使うオプション名前や住所の...

Laravel Error についてのメモ

laravelを使う時に出てくるエラー対応...

Laravel logger でエラーログを chatwork に自動送信

Laravel 使ってエラー発生した場合、chatworkにエラー内容をリアルタイムで連絡するcha...

Laravel メンテナンスモード

Laravelのメンテナンスモードの使い方 Artisan down コマンド使ってメンテナンスモー...

laravel method の基本 get post put options

Laravel Routeでget post メソッド同時に設定したい！Laravel ルート制約の...

Laravel Email バリデーションについて

Laravel Validation Email チェックする際の注意点、バリデーションルールオプシ...

Laravel Log の基本設定＆使い方

Laravel Logの基本設定エラー発生時にslackに連絡通知する設定方法 tailコマンド使...

Laravel リクエストログ出力

Laravelでリクエストログを出力する手順をまとめました。...

Lumen と Laravel 違い比較

軽量で速いマイクロフレームワークlumenとlaravelの違い、使い方比較と本当にlumen必要か...

Laravel を API サーバーとしての初期設定

Laravel インストールからローカル環境のSail docker開発、初期設定までプロジェクト構...

Laravel tinker 使って DB データベース接続とコマンド

Laravel tinker REPLツール使ってDBアクセス、環境確認など対話式で楽しく遊べる...

Laravel Sail で Docker 環境構築

Laravel Sail で Docker 開発環境PHP Mysql phpMyAdmin構築 s...

Laravel timestamp() auto update 有効化無効化

Laravel updated_at timestamp自動にしたい！MysqlはすぐにできるけどS...

laravel session を制する

laravel sesssion 使い方を紹介、読込保存削除を使えるようになったらsession制覇...

Laravel Sanctum 使って API トークン JWT 認証と SPA 認証

Laravel JWT APIトークンの仕組みと Laravel Sanctum SPA認証使って認...

Laravel 429 Too Many Requests

Laravel 19使ってAPIサーバー構築とフロントはReact nextjsで構築しています。複...

Laravel toSql パラメータ付きで出力

Laravel Query Builder toSqlで出力したsql文にパラメータを自動でセット...

Laravel Test についてのメモ

Laravel自動テスト行う際のコマンドと設定 faker 使ってデータ生成...

laravel に vuejs 使うための初期設定

PHPフレームワークlaravelにvuejs入れる時の初期設定まとめ、備忘録的...

Laravel 5.1 から 8.1 にバージョンアップ

laravel5 から8にアップグレードする際に遭遇したエラーとカスタマイズauth認証の設定を修正...

Lumen8 で JWT ユーザー認証

Lumen8でJWT認証のAPIサーバー構築してみた、便利になった時代だなあ...

HTML から PDF に変換 PHP ライブラリ mPDF の設定

HTMLレンダリングしてPDFに変換出力するライブリmpdfを使いこなせるための設定いろいろ...

PHP 7.4 にアップグレードして使えなくなる機能

php 5 から php7.4 にアップする作業があったので、アップグレード時のエラーと7.4では動...

PHP 8 リリース新機能と変更

php8がリリースされたので、新機能と特徴などの資料まとめました。25周年迎えたPHPは更に速いプロ...

解決！phpMyAdmin テーブル構造の内容が表示されない問題

phpmyadmin5.0.1のxampp入れたらテーブル構造メニューが真っ白になって表示されない...

php.ini 初期設定のいろいろ

php ini ローカル環境や新規リモート環境の初期設定...

PHP 文字列長さ・文字列の幅を取得方法

PHP 文字列操作関数マルチバイト文字列日本語韓国語中国語の長さ取得など...

開発時によく使うゼロ埋めパディング作業まとめ

mysql twig phpとjavascriptでよく使うゼロ埋めのいろいろ...

Laravel schedule 設定

Laravel スケジュール管理の基本とtimezone設定などlaravel 8最新メソッド説明...

Exception: Class 'ZipArchive' not found

エクセル操作でZipArchive classが見つからないエラーがあったので、対応しました。...

twig 3 人気 PHP テンプレートエンジンがバージョンアップ

以前からtwigテンプレートエンジン使っていて、非常にパワーフルで使いやすさに魅了しました。15日に...

Smarty HTTP URL 取得できるサーバー関数

スマーティで取得するサーバー関数URLとenvなど...