Laravelで堅(jiān)牢なRESTFUL APIを構(gòu)築するには、CRUD操作にリソースコントローラーを使用し、エンドポイントのバージョン、一貫したJSON応答を返し、入力を早期に検証し、例外をグローバルに処理します。まず、リソースコントローラーを生成し、複數(shù)名詞とHTTP動(dòng)詞を使用してルートを定義します。第二に、/API/V1/投稿などのバージョンされたプレフィックスの下でグループルートして、後方互換性を確保します。第三に、Laravelの応答ヘルパーを使用した成功、データ、メッセージフィールドを含む均一な形式ですべての応答を構(gòu)成します。第4に、フォームリクエストまたはインライン検証を使用して入力を検証して、悪いデータを防止します。最後に、app \ exceptions \ハンドラーを介してグローバルに例外を処理して、構(gòu)造化されたエラー応答を返します。

LaravelでRestful APIを構(gòu)築するとき、目標(biāo)は機(jī)能的であるだけでなく、スケーラブル、保守性、安全なものを作成することです。 Laravelは、箱から出してしっかりとした基盤(pán)を提供しますが、コードを構(gòu)成し、その機(jī)能を適切に活用する方法を知ることで、すべての違いが得られます。

リソースコントローラーを使用し、ルートネーミングコンベンションを使用します

Laravelのリソースコントローラーは、標(biāo)準(zhǔn)のCRUD操作に最適です。一貫したURL構(gòu)造を強(qiáng)制し、ルートを自動(dòng)的にマッピングすることにより、ボイラープレートを削減します。

• php artisan make:controller PostController --resourceを?qū)g行して、すべての標(biāo)準(zhǔn)メソッドを備えたコントローラーを生成します。
• Route::resource('posts', PostController::class);
• URL（ /api/posts 、 /api/comments ）の複數(shù)名詞に固執(zhí)し、HTTP動(dòng)詞を使用してアクションを示します（取得、投稿、配置、削除）。

このアプローチにより、APIは予測(cè)可能であり、他の人が理解または統(tǒng)合しやすくなります。

APIエンドポイントのバージョン

APIはしばしば時(shí)間の経過(guò)とともに進(jìn)化し、変化を破ると既存のクライアントに問(wèn)題を引き起こす可能性があります。そのため、APIを初日からバージョンすることが重要です。

• /api/v1/postsようなバージョンされたプレフィックスの下でルートを整理します
• ルートをグループ化することでこれを行うことができます。

ルート::プレフィックス（ 'v1'） - > group（function（）{
    ルート:: apiresource（ 'posts'、postcontroller :: class）;
}）;

これにより、既存のエンドポイントに影響を與えることなく、新しいエンドポイントを安全に導(dǎo)入できます。動(dòng)作を大幅に変更する必要がある場(chǎng)合は、古いバージョンを変更する代わりに新しいバージョンを作成します。

一貫したJSON構(gòu)造を返します

API応答の一貫性は、クライアントがデータをより確実に解析し、エラーを優(yōu)雅に処理するのに役立ちます。

次のような生データを返す代わりに

return ['data' => $ posts];

アプリ全體に標(biāo)準(zhǔn)形式を作成します。

 {
  「成功」：本當(dāng)、
  "データ"： { ... }、
  「メッセージ」：「正常に取得された投稿」
}

ヘルパー機(jī)能を構(gòu)築するか、Laravelのresponse() Helperを使用してリターンをラップできます。

 return Response（） - > json（[
    「成功」=>本當(dāng)、
    「データ」=> $投稿、
    「メッセージ」=> '投稿が正常に取得されました'
]）;

エラーについては、適切なステータスコードを返し、メッセージフィールドを含めて、クライアントが何がうまくいかなかったかを知るようにします。

入力を早期に明確に検証します

入ってくるデータを決して信用しないでください - 先に進(jìn)む前に常にそれを検証してください。 Laravelは、ロジックを清潔に保つ強(qiáng)力な検証ツールを提供します。

複雑な検証にフォームリクエストを使用します。

 PHP Artisan Make：Request StorePostrequest

次に、コントローラー方法で：

パブリックファンクションストア（StorePostrequest $ request）
{
    //検証が渡され、続行します
}

または、より簡(jiǎn)単な場(chǎng)合には、インライン検証を使用します。

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

検証が失敗した場(chǎng)合、Laravelは詳細(xì)なメッセージで422エラーを返します。各フィールドを手動(dòng)で確認(rèn)する必要はありません。

また、 App\Exceptions\Handlerを使用して、グローバルに例外をキャッチしてフォーマットしてください。これにより、予期しない問(wèn)題でさえ構(gòu)造化されたJSON応答を返します。

それは基本的に、Laravelで堅(jiān)実なRestful APIをセットアップする方法です。それは複雑ではありませんが、これらの基本を正しくすることで、後で多くの頭痛からあなたを救います。

以上がLaravelを使用して堅(jiān)牢なRESTFUL APIを構(gòu)築する方法の詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。