{"id":1037,"date":"2025-01-18T12:19:25","date_gmt":"2025-01-18T04:19:25","guid":{"rendered":"https:\/\/www.laixuexila.com\/?p=1037"},"modified":"2025-01-18T12:19:25","modified_gmt":"2025-01-18T04:19:25","slug":"laravel-restful-api-%e5%bc%80%e5%8f%91%ef%bc%9a%e5%85%a8%e9%9d%a2%e6%8c%87%e5%af%bc%e4%b8%8e%e6%9c%80%e4%bd%b3%e5%ae%9e%e8%b7%b5","status":"publish","type":"post","link":"https:\/\/www.laixuexila.com\/index.php\/2025\/01\/18\/laravel-restful-api-%e5%bc%80%e5%8f%91%ef%bc%9a%e5%85%a8%e9%9d%a2%e6%8c%87%e5%af%bc%e4%b8%8e%e6%9c%80%e4%bd%b3%e5%ae%9e%e8%b7%b5\/","title":{"rendered":"Laravel RESTful API \u5f00\u53d1\uff1a\u5168\u9762\u6307\u5bfc\u4e0e\u6700\u4f73\u5b9e\u8df5"},"content":{"rendered":"\n
\n

Laravel \u63d0\u4f9b\u4e86\u5f3a\u5927\u7684\u529f\u80fd\u6765\u5e2e\u52a9\u5f00\u53d1 RESTful API\uff0c\u80fd\u591f\u5904\u7406 HTTP \u8bf7\u6c42\u3001\u8fd4\u56de JSON \u6570\u636e\u3001\u9a8c\u8bc1\u8f93\u5165\u3001\u8eab\u4efd\u9a8c\u8bc1\u7b49\u64cd\u4f5c\u3002\u672c\u6587\u5c06\u8be6\u7ec6\u4ecb\u7ecd\u5982\u4f55\u4f7f\u7528 Laravel \u5f00\u53d1 RESTful API\uff0c\u5305\u62ec\u8def\u7531\u3001\u63a7\u5236\u5668\u3001\u8d44\u6e90\u3001\u9a8c\u8bc1\u3001\u8eab\u4efd\u9a8c\u8bc1\u548c\u6d4b\u8bd5\u3002<\/p>\n<\/blockquote>\n\n\n\n

1. \u4ec0\u4e48\u662f RESTful API\uff1f<\/strong><\/h3>\n\n\n\n

RESTful API\uff08\u8868\u8ff0\u6027\u72b6\u6001\u8f6c\u79fb\u5e94\u7528\u7a0b\u5e8f\u7f16\u7a0b\u63a5\u53e3\uff09\u662f\u4e00\u79cd\u5e38\u7528\u7684 Web \u670d\u52a1\u67b6\u6784\u98ce\u683c\uff0c\u57fa\u4e8e HTTP \u534f\u8bae\uff0c\u7528\u4e8e\u5728\u5ba2\u6237\u7aef\u548c\u670d\u52a1\u5668\u4e4b\u95f4\u8fdb\u884c\u6570\u636e\u4ea4\u6362\u3002RESTful API \u4f7f\u7528\u6807\u51c6\u7684 HTTP \u52a8\u4f5c\uff0c\u5982 GET\u3001POST\u3001PUT\u3001DELETE \u7b49\uff0c\u901a\u8fc7 URL \u548c HTTP \u8bf7\u6c42\u7684\u65b9\u5f0f\u8bbf\u95ee\u548c\u64cd\u4f5c\u8d44\u6e90\u3002<\/p>\n\n\n\n

2. \u5728 Laravel \u4e2d\u521b\u5efa RESTful API<\/strong><\/h3>\n\n\n\n

2.1 \u521b\u5efa API \u8def\u7531<\/h4>\n\n\n\n

\u5728 Laravel \u4e2d\uff0cAPI \u8def\u7531\u901a\u5e38\u5b9a\u4e49\u5728 routes\/api.php<\/code> \u6587\u4ef6\u4e2d\u3002\u4e0e web \u8def\u7531\u4e0d\u540c\uff0cAPI \u8def\u7531\u901a\u5e38\u6ca1\u6709\u4f1a\u8bdd\u72b6\u6001\uff0c\u5b83\u4eec\u662f\u65e0\u72b6\u6001\u7684\uff0c\u9002\u5408\u5904\u7406 API \u8bf7\u6c42\u3002<\/p>\n\n\n\n

\/\/ routes\/api.php\n\nuse App\\Http\\Controllers\\Api\\PostController;\n\nRoute::get('\/posts', [PostController::class, 'index']);  \/\/ \u83b7\u53d6\u6240\u6709\u5e16\u5b50\nRoute::get('\/posts\/{id}', [PostController::class, 'show']);  \/\/ \u83b7\u53d6\u5355\u4e2a\u5e16\u5b50\nRoute::post('\/posts', [PostController::class, 'store']);  \/\/ \u521b\u5efa\u65b0\u5e16\u5b50\nRoute::put('\/posts\/{id}', [PostController::class, 'update']);  \/\/ \u66f4\u65b0\u5e16\u5b50\nRoute::delete('\/posts\/{id}', [PostController::class, 'destroy']);  \/\/ \u5220\u9664\u5e16\u5b50<\/code><\/pre>\n\n\n\n
2.2 \u521b\u5efa API \u63a7\u5236\u5668<\/h4>\n\n\n\n
Laravel \u63d0\u4f9b\u4e86\u4e00\u4e2a\u547d\u4ee4\u6765\u5feb\u901f\u751f\u6210\u63a7\u5236\u5668\uff0c\u7279\u522b\u662f API \u63a7\u5236\u5668\uff0c\u53ef\u4ee5\u4f7f\u7528 --api<\/code> \u9009\u9879\u751f\u6210\u53ea\u5904\u7406 API \u8bf7\u6c42\u7684\u63a7\u5236\u5668\u3002\u63a7\u5236\u5668\u901a\u5e38\u4f1a\u8fd4\u56de JSON \u683c\u5f0f\u7684\u6570\u636e\u3002<\/p>\n\n\n\n
php artisan make:controller Api\/PostController --api<\/code><\/pre>\n\n\n\n
\u751f\u6210\u7684\u63a7\u5236\u5668\u793a\u4f8b\u5982\u4e0b\uff1a<\/p>\n\n\n\n
\/\/ app\/Http\/Controllers\/Api\/PostController.php\n\nnamespace App\\Http\\Controllers\\Api;\n\nuse App\\Http\\Controllers\\Controller;\nuse App\\Models\\Post;\nuse Illuminate\\Http\\Request;\n\nclass PostController extends Controller\n{\n    \/\/ \u83b7\u53d6\u6240\u6709\u5e16\u5b50\n    public function index()\n    {\n        $posts = Post::all();\n        return response()->json($posts);  \/\/ \u8fd4\u56de JSON \u683c\u5f0f\u7684\u6240\u6709\u5e16\u5b50\n    }\n\n    \/\/ \u83b7\u53d6\u5355\u4e2a\u5e16\u5b50\n    public function show($id)\n    {\n        $post = Post::find($id);\n\n        if (!$post) {\n            return response()->json(['message' => 'Post not found'], 404);\n        }\n\n        return response()->json($post);  \/\/ \u8fd4\u56de JSON \u683c\u5f0f\u7684\u5355\u4e2a\u5e16\u5b50\n    }\n\n    \/\/ \u521b\u5efa\u65b0\u5e16\u5b50\n    public function store(Request $request)\n    {\n        $validatedData = $request->validate([\n            'title' => 'required|string|max:255',\n            'content' => 'required|string',\n        ]);\n\n        $post = Post::create($validatedData);\n        return response()->json($post, 201);  \/\/ \u8fd4\u56de\u65b0\u521b\u5efa\u7684\u5e16\u5b50\u5e76\u8fd4\u56de 201 \u72b6\u6001\u7801\n    }\n\n    \/\/ \u66f4\u65b0\u5e16\u5b50\n    public function update(Request $request, $id)\n    {\n        $post = Post::find($id);\n\n        if (!$post) {\n            return response()->json(['message' => 'Post not found'], 404);\n        }\n\n        $validatedData = $request->validate([\n            'title' => 'sometimes|required|string|max:255',\n            'content' => 'sometimes|required|string',\n        ]);\n\n        $post->update($validatedData);\n        return response()->json($post);  \/\/ \u8fd4\u56de\u66f4\u65b0\u540e\u7684\u5e16\u5b50\n    }\n\n    \/\/ \u5220\u9664\u5e16\u5b50\n    public function destroy($id)\n    {\n        $post = Post::find($id);\n\n        if (!$post) {\n            return response()->json(['message' => 'Post not found'], 404);\n        }\n\n        $post->delete();\n        return response()->json(['message' => 'Post deleted successfully']);\n    }\n}<\/code><\/pre>\n\n\n\n
2.3 API \u54cd\u5e94<\/h4>\n\n\n\n
Laravel \u63d0\u4f9b\u4e86\u4fbf\u6377\u7684 response()->json()<\/code> \u65b9\u6cd5\u6765\u8fd4\u56de JSON \u6570\u636e\u3002\u53ef\u4ee5\u6307\u5b9a\u72b6\u6001\u7801\u548c\u6d88\u606f\uff1a<\/p>\n\n\n\n
return response()->json($data, 200);  \/\/ \u8fd4\u56de\u6210\u529f\u54cd\u5e94\nreturn response()->json(['message' => 'Not found'], 404);  \/\/ \u8fd4\u56de\u5931\u8d25\u54cd\u5e94<\/code><\/pre>\n\n\n\n
3. \u8bf7\u6c42\u9a8c\u8bc1<\/strong><\/h3>\n\n\n\n
\u5728 API \u4e2d\u5904\u7406\u7528\u6237\u63d0\u4ea4\u7684\u6570\u636e\u65f6\uff0c\u9a8c\u8bc1\u8bf7\u6c42\u662f\u975e\u5e38\u91cd\u8981\u7684\u4e00\u6b65\u3002Laravel \u63d0\u4f9b\u4e86\u5f3a\u5927\u7684\u9a8c\u8bc1\u529f\u80fd\uff0c\u53ef\u4ee5\u786e\u4fdd\u6570\u636e\u7684\u6b63\u786e\u6027\u548c\u5b89\u5168\u6027\u3002\u9a8c\u8bc1\u903b\u8f91\u53ef\u4ee5\u653e\u5728\u63a7\u5236\u5668\u4e2d\uff0c\u4f7f\u7528 Request<\/code> \u5bf9\u8c61\u7684 validate<\/code> \u65b9\u6cd5\u3002<\/p>\n\n\n\n
public function store(Request $request)\n{\n    $validatedData = $request->validate([\n        'title' => 'required|string|max:255',\n        'content' => 'required|string',\n    ]);\n\n    $post = Post::create($validatedData);\n    return response()->json($post, 201);\n}<\/code><\/pre>\n\n\n\n
\u5982\u679c\u9a8c\u8bc1\u5931\u8d25\uff0cLaravel \u4f1a\u81ea\u52a8\u8fd4\u56de 422 \u54cd\u5e94\u548c\u8be6\u7ec6\u7684\u9519\u8bef\u4fe1\u606f\u3002<\/p>\n\n\n\n
4. \u8eab\u4efd\u9a8c\u8bc1\u4e0e\u6388\u6743<\/strong><\/h3>\n\n\n\n
4.1 \u4f7f\u7528 API \u4ee4\u724c\u8eab\u4efd\u9a8c\u8bc1\uff08Passport\uff09<\/h4>\n\n\n\n
Laravel \u63d0\u4f9b\u4e86 Passport<\/a> \u5305\uff0c\u7b80\u5316\u4e86 API \u8eab\u4efd\u9a8c\u8bc1\u8fc7\u7a0b\u3002Passport \u5141\u8bb8\u4f60\u901a\u8fc7 OAuth2 \u5b9e\u73b0 API \u4ee4\u724c\u8eab\u4efd\u9a8c\u8bc1\u3002<\/p>\n\n\n\n
\u5b89\u88c5 Passport\uff1a<\/p>\n\n\n\n
composer require laravel\/passport\nphp artisan migrate\nphp artisan passport:install<\/code><\/pre>\n\n\n\n
\u5728 config\/auth.php<\/code> \u4e2d\u8bbe\u7f6e API \u9a71\u52a8\u4e3a Passport\uff1a<\/p>\n\n\n\n
\/\/ config\/auth.php\n\n'guards' => [\n    'api' => [\n        'driver' => 'passport',\n        'provider' => 'users',\n    ],\n],<\/code><\/pre>\n\n\n\n
\u5728\u7528\u6237\u6a21\u578b\u4e2d\uff0c\u4f7f\u7528 HasApiTokens<\/code> \u7279\u6027\uff1a<\/p>\n\n\n\n
\/\/ app\/Models\/User.php\n\nnamespace App\\Models;\n\nuse Illuminate\\Database\\Eloquent\\Factories\\HasFactory;\nuse Illuminate\\Database\\Eloquent\\Model;\nuse Laravel\\Passport\\HasApiTokens;\n\nclass User extends Model\n{\n    use HasApiTokens;\n}<\/code><\/pre>\n\n\n\n
\u751f\u6210\u548c\u4f7f\u7528 API \u4ee4\u724c\uff1a<\/p>\n\n\n\n
$user = User::find(1);\n$token = $user->createToken('MyApp')->accessToken;<\/code><\/pre>\n\n\n\n
4.2 \u4fdd\u62a4 API \u8def\u7531<\/h4>\n\n\n\n
\u4f60\u53ef\u4ee5\u901a\u8fc7 auth:api<\/code> \u4e2d\u95f4\u4ef6\u6765\u4fdd\u62a4\u9700\u8981\u8eab\u4efd\u9a8c\u8bc1\u7684 API \u8def\u7531\uff1a<\/p>\n\n\n\n
\/\/ routes\/api.php\n\nRoute::middleware('auth:api')->get('\/user', function (Request $request) {\n    return $request->user();\n});<\/code><\/pre>\n\n\n\n
5. API \u8d44\u6e90\uff08API Resources\uff09<\/strong><\/h3>\n\n\n\n
\u5728\u5f00\u53d1 RESTful API \u65f6\uff0c\u901a\u5e38\u9700\u8981\u5bf9\u8fd4\u56de\u7684\u6a21\u578b\u8fdb\u884c\u683c\u5f0f\u5316\u3002Laravel \u63d0\u4f9b\u4e86 API \u8d44\u6e90\uff08API Resources\uff09\u6765\u8f7b\u677e\u8f6c\u6362\u6a21\u578b\u4e3a JSON \u683c\u5f0f\u3002\u4f60\u53ef\u4ee5\u751f\u6210\u8d44\u6e90\u7c7b\u6765\u5904\u7406\u8fd9\u4e9b\u8f6c\u6362\u3002<\/p>\n\n\n\n
php artisan make:resource PostResource<\/code><\/pre>\n\n\n\n
\u751f\u6210\u7684\u8d44\u6e90\u7c7b\u793a\u4f8b\u5982\u4e0b\uff1a<\/p>\n\n\n\n
\/\/ app\/Http\/Resources\/PostResource.php\n\nnamespace App\\Http\\Resources;\n\nuse Illuminate\\Http\\Resources\\Json\\JsonResource;\n\nclass PostResource extends JsonResource\n{\n    public function toArray($request)\n    {\n        return [\n            'id' => $this->id,\n            'title' => $this->title,\n            'content' => $this->content,\n        ];\n    }\n}<\/code><\/pre>\n\n\n\n
\u5728\u63a7\u5236\u5668\u4e2d\u4f7f\u7528\u8d44\u6e90\uff1a<\/p>\n\n\n\n
use App\\Http\\Resources\\PostResource;\n\npublic function show($id)\n{\n    $post = Post::find($id);\n\n    if (!$post) {\n        return response()->json(['message' => 'Post not found'], 404);\n    }\n\n    return new PostResource($post);  \/\/ \u4f7f\u7528\u8d44\u6e90\u8fd4\u56de\u683c\u5f0f\u5316\u540e\u7684\u6570\u636e\n}<\/code><\/pre>\n\n\n\n
6. API \u6d4b\u8bd5<\/strong><\/h3>\n\n\n\n
Laravel \u63d0\u4f9b\u4e86\u5f3a\u5927\u7684\u6d4b\u8bd5\u529f\u80fd\uff0c\u53ef\u4ee5\u5e2e\u52a9\u4f60\u6d4b\u8bd5 API \u7684\u5404\u4e2a\u65b9\u9762\u3002\u4f60\u53ef\u4ee5\u4f7f\u7528 php artisan make:test<\/code> \u547d\u4ee4\u751f\u6210 API \u6d4b\u8bd5\u7c7b\u3002<\/p>\n\n\n\n
php artisan make:test PostApiTest<\/code><\/pre>\n\n\n\n
\u5728\u751f\u6210\u7684\u6d4b\u8bd5\u7c7b\u4e2d\uff0c\u4f60\u53ef\u4ee5\u7f16\u5199\u9488\u5bf9 API \u8def\u7531\u7684\u6d4b\u8bd5\uff1a\/\/ tests\/Feature\/PostApiTest.php

namespace Tests\\Feature;

use Tests\\TestCase;
use Illuminate\\Foundation\\Testing\\RefreshDatabase;

class PostApiTest extends TestCase
{
    use RefreshDatabase;

    \/** @test *\/
    public function it_can_create_a_post()
    {
        $response = $this->postJson(‘\/api\/posts’, [
            ‘title’ => ‘New Post’,
            ‘content’ => ‘Post content.’,
        ]);

        $response->assertStatus(201)
                 ->assertJsonStructure([
                     ‘id’,
                     ‘title’,
                     ‘content’,
                 ]);
    }

    \/** @test *\/
    public function it_can_get_all_posts()
    {
        $response = $this->getJson(‘\/api\/posts’);
        $response->assertStatus(200);
    }
}<\/p>\n","protected":false},"excerpt":{"rendered":"
Laravel \u63d0\u4f9b\u4e86\u5f3a\u5927\u7684\u529f\u80fd\u6765\u5e2e\u52a9\u5f00\u53d1 RESTful API\uff0c\u80fd\u591f\u5904\u7406 HTTP \u8bf7\u6c42\u3001\u8fd4\u56de JSON  […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[62],"tags":[],"class_list":["post-1037","post","type-post","status-publish","format-standard","hentry","category-laravel"],"_links":{"self":[{"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts\/1037","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/comments?post=1037"}],"version-history":[{"count":1,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts\/1037\/revisions"}],"predecessor-version":[{"id":1038,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts\/1037\/revisions\/1038"}],"wp:attachment":[{"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/media?parent=1037"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/categories?post=1037"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/tags?post=1037"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}