新しいLaravelプロジェクトを作成し、サービスを開始します。 2。モデル、移行、コントローラーを生成し、移行を?qū)g行します。 3.ルート/api.phpのRESTFULルートを定義します。 4.ポストコントローラーに追加、削除、変更、クエリメソッドを?qū)g裝し、JSON応答を返します。 5. PostmanまたはCurlでAPI機(jī)能をテストします。 6.オプションで、Sanctumを介してAPI認(rèn)証を追加します。最後に、実用的なアプリケーションに適した完全かつ拡張可能なLaravel REST API、完全かつ拡張可能な構(gòu)造を取得します。

LaravelでREST APIを構(gòu)築することは、ルーティング、雄弁なORM、リクエストの処理用の組み込み機(jī)能のおかげで簡(jiǎn)単です。 Laravelを使用して、きれいで機(jī)能的なREST APIを作成するのに役立つ実用的なガイドを次に示します。

1.新しいLaravelプロジェクトを設(shè)定します

Composerを使用して新しいLaravelプロジェクトを作成することから始めます。

作曲家Create-Project Laravel/Laravel API-Demo
CD API-DEMO

次に、開発サーバーを起動(dòng)して、すべてが機(jī)能することを確認(rèn)します。

 PHP職人サーブ

http://localhost:8000にLaravelウェルカムページが表示されます。

2。モデル、移行、およびコントローラーを作成します

投稿を管理するための簡(jiǎn)単なAPIを作成しましょう。 -aフラグを使用したmake:modelコマンドを使用して、モデル、移行、工場(chǎng)、コントローラーを生成します。

 PHP Artisan Make：Model Post -A

これが作成します：

• app/Models/Post.php - 雄弁さモデル
• database/migrations/xxxx_create_posts_table.php - 移行
• app/Http/Controllers/PostController.php - コントローラー
• database/factories/PostFactory.php - 見るため

移行ファイルを編集して、ポストフィールドを定義します。

 //データベース/移行/....._ create_posts_table.php
schema :: create（ 'posts'、function（blueprint $ table）{
    $ table-> id（）;
    $ table-> string（ 'title'）;
    $ table-> text（ 'body'）;
    $ table-> timestamps（）;
}）;

移行を?qū)g行します：

 PHPの職人が移行します

3。APIルートを定義します

routes/api.phpを開き、 Route::apiResource()を使用して安らかなルートを定義します。

 app \ http \ controllers \ postControllerを使用します。

ルート:: apiresource（ 'posts'、postcontroller :: class）;

これらのルートは、標(biāo)準(zhǔn)の休憩アクションに自動(dòng)的にマッピングされます。

• GET /api/posts →インデックス
• POST /api/posts →ストア
• GET /api/posts/{id} →show
• PUT/PATCH /api/posts/{id} →更新
• DELETE /api/posts/{id} →破壊

すべてのルートを表示できます。

 PHP職人ルート：リスト - パス= API

4.コントローラーメソッドを?qū)g裝します

app/Http/Controllers/PostController.phpを開き、Eloquentを使用してロジックを入力します。

 app \ models \ postを使用します。
Illuminate \ http \ requestを使用します。

クラスPostControllerはコントローラーを拡張します
{
    パブリック関數(shù)インデックス（）
    {
        return Response（） - > json（post :: all（））;
    }

    パブリックファンクションストア（リクエスト$ request）
    {
        $ validated = $ request-> validate（[[
            'title' => '必須|文字列|マックス：255'、
            'body' => '必須|文字列'、
        ]）;

        $ post = post :: create（$ validated）;

        return Response（） - > json（$ post、201）;
    }

    パブリック機(jī)能ショー（$ id）
    {
        $ post = post :: find（$ id）;

        if（！$ post）{
            return response（） - > json（['message' => 'post not in']、404）;
        }

        return Response（） - > json（$ post）;
    }

    パブリック関數(shù)の更新（リクエスト$ request、$ id）
    {
        $ post = post :: find（$ id）;

        if（！$ post）{
            return response（） - > json（['message' => 'post not in']、404）;
        }

        $ validated = $ request-> validate（[[
            'title' => '必須|文字列|マックス：255'、
            'body' => '必須|文字列'、
        ]）;

        $ post-> update（$ validated）;

        return Response（） - > json（$ post）;
    }

    パブリック関數(shù)破壊（$ id）
    {
        $ post = post :: find（$ id）;

        if（！$ post）{
            return response（） - > json（['message' => 'post not in']、404）;
        }

        $ post-> delete（）;

        return response（） - > json（['message' => 'post deleted']）;
    }
}

？ Laravelは、データをresponse()->json()に渡すと、JSON応答を自動(dòng)的に返します。また、APIルートは既にCSRFの証拠によって保護(hù)されており、 apiミドルウェア（Stateless）を使用しています。

5.APIをテストします

ポストマン、カール、サンダークライアント（VSコード）などのツールを使用して、エンドポイントをテストします。

例：カールで投稿を作成します

curl -x post http：// localhost：8000/api/posts \
  -h "content-type：application/json" \
  -d '{"title"：「私の最初の投稿」、「ボデ?！梗骸袱长欷膝堀钎￥扦埂箎'

作成された投稿と201ステータスでJSON応答を取得する必要があります。

6。 （オプション）SanctumにAPI認(rèn)証を追加します

保護(hù)されたルートの場(chǎng)合、Laravel Sanctumを使用して、トークンベースの認(rèn)証を追加します。

Sanctumをインストール：

作曲家にはLaravel/Sanctumが必要です
PHP Artisan Vendor：Publish -Provider = "Laravel \ Sanctum \ SanctumserviceProvider"
PHPの職人が移行します

app/Http/Kernel.phpにsanctumミドルウェアを'api'の下に追加します。

 'API' => [
    \ laravel \ sanctum \ http \ middleware \ sersefrontendrequestsarestateful :: class、
    「スロットル：API」、
    \ Illuminate \ Routing \ Middleware \ sultiftbindings :: class、
]、、

あなたのルートを保護(hù)します：

ルート:: Middleware（ 'auth：sanctum'） - > apiresource（ 'posts'、postController :: class）;

これで、ユーザーはAPIにアクセスするためにトークンで認(rèn)証する必要があります。

最終メモ

• 検証ロジックをきれいに保ちます - 複雑なルールのフォームリクエストを使用して検討します。
• APIリソース（ php artisan make:resource PostResource ）を使用して、応答をフォーマットします。
• 常にエラーを優(yōu)雅に処理します（例：404、422）。
• 長期的な安定性にバージョンリング（ /api/v1/posts ）を使用します。

それでおしまい。これで、Laravelを使用して完全に機(jī)能するREST APIができました。清潔でスケーラブルで、実際の使用の準(zhǔn)備ができています。

以上がLaravelでREST APIを構(gòu)築する方法は？の詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國語 Web サイトの他の関連記事を參照してください。