PHP フレームワークを使用して RESTful API を構築するためのガイドライン フレームワークの選択: Laravel などのフレームワークを使用します。 Laravel のインストール: Laravel インストーラーを使用して Laravel をインストールします。ルートを定義する: URL を Routes/api.php のコントローラー アクションにマップします。コントローラーの作成: app/Http/Controllers にコントローラーを作成して、リクエストを処理し、応答を返します。リクエストとレスポンスを処理する:response()->json() などのヘルパー メソッドを使用してレスポンスを簡素化し、コントローラ メソッドを使用してリクエストを処理します。実際のケース: ユーザー API: モデル、コントローラーを作成し、API を起動してユーザー管理機能を実装します。
はじめに
RESTful API (Representational State Transfer) は、使いやすく、効率的で、スケーラブルな API を構築するための一般的な設計スタイルです。この記事では、PHP フレームワークを使用して RESTful API を構築する方法を説明します。
フレームワークを選択する
Laravel、Symfony、Lumen など、RESTful API の構築に利用できる PHP フレームワークが多数あります。この記事ではLaravelを例として説明します。
Laravelをインストールする
composer global require laravel/installer laravel new my-api
ルートを定義する
ルートとは、URLをコントローラーとメソッドにマップするルールです。 Laravel では、API ルートを routes/api.php
ファイルで定義します。 routes/api.php
文件中定义 API 路由。
Route::get('/users', 'UserController@index'); Route::post('/users', 'UserController@store'); Route::get('/users/{user}', 'UserController@show');
创建控制器
控制器处理 API 请求并返回响应。在 Laravel 中,控制器位于 app/Http/Controllers
目录中。
<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use App\User; class UserController extends Controller { public function index() { return User::all(); } public function store(Request $request) { $user = User::create($request->all()); return response()->json($user, 201); } public function show(User $user) { return $user; } }
处理请求和响应
控制器方法处理请求并返回响应。Laravel 提供了各种辅助方法来简化此过程,例如 response()->json()
用于返回 JSON 响应。
实战案例:用户 API
让我们创建一个简单的用户 API 作为实战案例。
创建模型
<?php namespace App; use Illuminate\Database\Eloquent\Model; class User extends Model { protected $fillable = ['name', 'email']; }
创建控制器
<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use App\User; class UserController extends Controller { public function index() { return User::all(); } public function store(Request $request) { $user = User::create($request->all()); return response()->json($user, 201); } public function show(User $user) { return $user; } }
启动 API
php artisan serve
现在,您可以使用 cURL 或 Postman 等工具测试 API:
curl http://localhost:8000/api/users
curl -X POST -d '{"name": "John", "email": "john@example.com"}' http://localhost:8000/api/users
curl http://localhost:8000/api/users/1
rrreeeapp/Http/Controllers
ディレクトリにあります。 🎜rrreee🎜🎜リクエストとレスポンスの処理🎜🎜🎜コントローラー メソッドはリクエストを処理し、レスポンスを返します。 Laravel は、JSON 応答を返すための response()->json()
など、このプロセスを簡素化するさまざまなヘルパー メソッドを提供します。 🎜🎜🎜実践例: ユーザー API🎜🎜🎜実践例として、簡単なユーザー API を作成してみましょう。 🎜🎜🎜モデルを作成🎜🎜rrreee🎜🎜コントローラーを作成🎜🎜rrreee🎜🎜APIを開始🎜🎜rrreee🎜これで、cURL や Postman などのツールを使用して API をテストできます: 🎜 curl http://localhost:8000/api/users
🎜curl -X POST -d '{"name": "John", "email": "john @ example.com"}' http://localhost:8000/api/users
🎜curl http://localhost:8000/api/users/1
🎜🎜以上がPHP フレームワークを使用して RESTful API を構築するためのガイドの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。