Laravel APIの書き方

インターネット アプリケーションやモバイル アプリケーションの開発に伴い、多くの企業や開発者は、フロント エンドとバック エンドを分離するアーキテクチャを採用し始めています。バック エンドは、フロント エンドが使用できる RESTful API を提供します。API をすばやく作成する方法と効率性は多くの開発者にとって懸念事項となっています。 Laravel は、完全なルーティング、ORM、ミドルウェア、その他のコンポーネントを提供する人気の PHP Web フレームワークで、API の作成が非常に簡単になります。この記事では、Laravel フレームワークで RESTful API を作成する方法を説明します。

1. Laravel フレームワークのインストールと構成

まず、Laravel フレームワークをインストールする必要があります。これは、Laravel の公式 Web サイトまたはコンポーザーからダウンロードできます:

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

その後、構成します。データベース、キャッシュ、キュー、その他のコンポーネントを .env ファイルで構成できます。便宜上、.env ファイル:

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

でデータベース情報を構成し、config/database.php ファイル: ## にデータベース情報を追加できます。 #

'mysql' => [
    'driver' => 'mysql',
    'host' => env('DB_HOST', '127.0.0.1'),
    'port' => env('DB_PORT', '3306'),
    'database' => env('DB_DATABASE', 'forge'),
    'username' => env('DB_USERNAME', 'forge'),
    'password' => env('DB_PASSWORD', ''),
    'charset' => 'utf8mb4',
    'collation' => 'utf8mb4_unicode_ci',
    'prefix' => '',
    'strict' => false,
    'engine' => null,
],

API インターフェイスの設計

API を作成する前に、API の機能と、必要なリクエスト パラメーターと応答データを決定する必要があります。このステップは非常に重要であり、 API の使用方法とその使用方法。たとえば、製品リストを取得する API を作成したいとします。その場合、次の情報が必要です:

リクエスト メソッド: GET
リクエスト URL:/api/products
リクエストパラメータ: パラメータは必要ありません
レスポンスデータ: 製品リスト

例は次のとおりです:

use AppProduct;

Route::get('/api/products', function () {
    return Product::all();
});

この例では、Laravel を使用します。フレームワークに付属するルートとモデルは、まずルーティング ファイル内で

GET リクエストされた URL アドレス /api/products を定義し、次に対応するコントローラー メソッドですべての URL を返します。データ。ここでは、データ操作を迅速かつ便利に実行できる ORM (オブジェクト リレーショナル マッピング) を使用してデータベースを操作します。

ミドルウェアの使用

ミドルウェアは、Laravel フレームワークの重要な概念であり、リクエストがコントローラー メソッドに到達する前または後に、ID などの一部の操作を実行できます。 . 検証などAPI を作成するときは、通常、API のセキュリティとパフォーマンスを確保するためにいくつかのミドルウェアを追加する必要があります。

たとえば、API バージョン、トークンが合法かどうかなどのリクエストのヘッダー情報を検証するミドルウェアを追加し、コントローラー メソッドでクエリを実行してデータを返すことができます。サンプル コードは次のとおりです。

use AppHttpMiddlewareVerifyApiToken;
use AppHttpMiddlewareVerifyApiVersion;

Route::middleware([VerifyApiToken::class, VerifyApiVersion::class])->group(function () {
    Route::get('/api/products', function () {
        return Product::all();
    });
});

この例では、

middleware メソッドを通じて 2 つのミドルウェア VerifyApiToken と VerifyApiVersion を追加しました。リクエストのセキュリティとバージョンの一貫性を確保するために、リクエストがコントローラ メソッドに到達する前に実行されます。

例外処理

例外処理も API を作成する際の重要なリンクです。これにより、入力パラメータ エラーなどの例外をより適切にキャプチャして処理できるようになります。クエリデータが存在しないなど。 Laravel フレームワークでは、

AppExceptionsHandler クラスを通じて例外を均一に処理できます。

たとえば、単一の製品を取得する API を実装し、その製品が存在しない場合に 404 ステータス コードとエラー メッセージを返すとします。コード例は次のとおりです:

Route::get('/api/products/{id}', function ($id) {
    $product = Product::find($id);
    if (!$product) {
        abort(404, '商品不存在');
    }
    return $product;
});

この例では、

find メソッドを使用して製品データをクエリします。クエリ結果が null の場合は、 を使用します。 ##メソッドは 404 ステータス コードとエラー メッセージを返します。例外処理を使用することで、API をより堅牢かつ安定させることができます。 最後に

上記の手順により、独自の RESTful API の作成を開始できます。 Laravel フレームワークは完全なルーティング、ミドルウェア、ORM、その他のコンポーネントを提供し、API の作成を非常にシンプルかつ効率的にします。もちろん、より詳細で専門的な API 作成ガイドは数多くありますが、この記事が読者に参考とインスピレーションを提供できれば幸いです。

以上がLaravel APIの書き方の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。