{"id":22630,"date":"2024-11-21T14:24:28","date_gmt":"2024-11-21T06:24:28","guid":{"rendered":"https:\/\/fwq.ai\/blog\/22630\/"},"modified":"2024-11-21T14:24:28","modified_gmt":"2024-11-21T06:24:28","slug":"laravel%e5%86%99api%e6%80%8e%e4%b9%88%e9%aa%8c%e8%af%81","status":"publish","type":"post","link":"https:\/\/fwq.ai\/blog\/22630\/","title":{"rendered":"laravel\u5199api\u600e\u4e48\u9a8c\u8bc1"},"content":{"rendered":"<p>\u968f\u7740web api\u7684\u666e\u53ca\uff0capi\u7684\u5b89\u5168\u6027\u53d8\u5f97\u8d8a\u6765\u8d8a\u91cd\u8981\u3002\u5728laravel\u4e2d\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528\u5185\u7f6e\u7684\u9a8c\u8bc1\u89c4\u5219\u548c\u4e2d\u95f4\u4ef6\u6765\u5bf9api\u8bf7\u6c42\u8fdb\u884c\u9a8c\u8bc1\u548c\u4fdd\u62a4\u3002<\/p>\n<ol>\n<li>\u4f7f\u7528Laravel\u5185\u7f6e\u7684\u9a8c\u8bc1\u89c4\u5219<\/li>\n<\/ol>\n<p>Laravel\u63d0\u4f9b\u4e86\u4e00\u7cfb\u5217\u7684\u9a8c\u8bc1\u89c4\u5219\uff0c\u5982\u201crequired\u201d\uff08\u5fc5\u586b\u9879\uff09\u3001\u201cemail\u201d\uff08\u90ae\u7bb1\u683c\u5f0f\uff09\u7b49\u7b49\u3002\u6211\u4eec\u53ef\u4ee5\u5c06\u8fd9\u4e9b\u89c4\u5219\u5e94\u7528\u5230\u6211\u4eec\u7684API\u63a5\u53e3\u4e2d\uff0c\u4ece\u800c\u4fdd\u8bc1\u63a5\u53e3\u53c2\u6570\u7684\u6b63\u786e\u6027\u3002<\/p>\n<p>\u4f8b\u5982\uff0c\u6211\u4eec\u60f3\u8981\u9a8c\u8bc1\u4e00\u4e2a\u6ce8\u518cAPI\u63a5\u53e3\u7684\u53c2\u6570\uff0c\u53ef\u4ee5\u4f7f\u7528\u4ee5\u4e0b\u4ee3\u7801\uff1a<\/p>\n<pre>public function register(Request $request) {\n    $validatedData = $request-&amp;gt;validate([\n        'name' =&amp;gt; 'required|string|max:255',\n        'email' =&amp;gt; 'required|string|email|max:255|unique:users',\n        'password' =&amp;gt; 'required|string|min:8',\n    ]);\n\n    \/\/ \u5bf9\u8bf7\u6c42\u53c2\u6570\u8fdb\u884c\u5904\u7406\n    \/\/ ...\n\n    \/\/ \u6ce8\u518c\u7528\u6237\n    \/\/ ...\n}<\/pre>\n<p>  \u767b\u5f55\u540e\u590d\u5236   <\/p>\n<p>\u5728\u4e0a\u9762\u7684\u4ee3\u7801\u4e2d\uff0c\u6211\u4eec\u4f7f\u7528\u4e86$request-&gt;validate()\u65b9\u6cd5\u6765\u5bf9\u8bf7\u6c42\u53c2\u6570\u8fdb\u884c\u9a8c\u8bc1\u3002\u5982\u679c\u9a8c\u8bc1\u5931\u8d25\uff0cLaravel\u4f1a\u81ea\u52a8\u629b\u51fa\u4e00\u4e2aValidationException\u5f02\u5e38\uff0c\u4e4b\u540e\u6211\u4eec\u9700\u8981\u5728\u5f02\u5e38\u5904\u7406\u5668\u4e2d\u5904\u7406\u8fd9\u4e2a\u5f02\u5e38\u3002<\/p>\n<ol>\n<li>\u4f7f\u7528Laravel\u5185\u7f6e\u7684\u4e2d\u95f4\u4ef6<\/li>\n<\/ol>\n<p>Laravel\u8fd8\u63d0\u4f9b\u4e86\u5f88\u591a\u4e2d\u95f4\u4ef6\u6765\u589e\u5f3aAPI\u7684\u5b89\u5168\u6027\u3002\u4ee5\u4e0b\u662f\u4e00\u4e9b\u5e38\u7528\u7684\u4e2d\u95f4\u4ef6\uff1a<\/p>\n<ul>\n<li>auth\uff1a\u7528\u4e8e\u7528\u6237\u8ba4\u8bc1\uff0c\u53ea\u5141\u8bb8\u5df2\u767b\u5f55\u7528\u6237\u8bbf\u95ee\u63a5\u53e3\uff1b<\/li>\n<li>throttle\uff1a\u7528\u4e8e\u9650\u5236API\u63a5\u53e3\u7684\u8bf7\u6c42\u9891\u7387\uff0c\u907f\u514d\u88ab\u653b\u51fb\u6216\u6ee5\u7528\uff1b<\/li>\n<li>cors\uff1a\u7528\u4e8e\u8de8\u57df\u8d44\u6e90\u5171\u4eab\uff0c\u5141\u8bb8\u8de8\u57df\u8bf7\u6c42\uff1b<\/li>\n<li>csrf\uff1a\u7528\u4e8e\u9632\u6b62\u8de8\u7ad9\u8bf7\u6c42\u4f2a\u9020\u653b\u51fb\uff1b<\/li>\n<\/ul>\n<p>\u6211\u4eec\u53ef\u4ee5\u76f4\u63a5\u5728\u8def\u7531\u5b9a\u4e49\u4e2d\u4f7f\u7528\u8fd9\u4e9b\u4e2d\u95f4\u4ef6\uff0c\u5982\u4e0b\u6240\u793a\uff1a<\/p>\n<pre>\/\/ \u5b9a\u4e49\u9700\u8981\u8ba4\u8bc1\u7684API\u63a5\u53e3\nRoute::middleware(['auth'])-&amp;gt;group(function () {\n    Route::post('\/api\/foo', 'FooController@create');\n    Route::put('\/api\/foo\/{id}', 'FooController@update');\n});\n\n\/\/ \u5b9a\u4e49\u5141\u8bb8\u8de8\u57df\u8bbf\u95ee\u7684API\u63a5\u53e3\nRoute::middleware(['cors'])-&amp;gt;group(function () {\n    Route::get('\/api\/bar', 'BarController@index');\n});\n\n\/\/ \u5b9a\u4e49\u9650\u5236\u8bf7\u6c42\u9891\u7387\u7684API\u63a5\u53e3\nRoute::middleware(['throttle'])-&amp;gt;group(function () {\n    Route::get('\/api\/baz', 'BazController@index');\n});<\/pre>\n<p>  \u767b\u5f55\u540e\u590d\u5236   <\/p>\n<ol>\n<li>\u81ea\u5b9a\u4e49\u4e2d\u95f4\u4ef6<\/li>\n<\/ol>\n<p>\u9664\u4e86\u4f7f\u7528Laravel\u5185\u7f6e\u7684\u4e2d\u95f4\u4ef6\u4e4b\u5916\uff0c\u6211\u4eec\u8fd8\u53ef\u4ee5\u81ea\u5b9a\u4e49\u4e2d\u95f4\u4ef6\u6765\u5b9e\u73b0\u66f4\u590d\u6742\u7684\u9a8c\u8bc1\u903b\u8f91\u3002<\/p>\n<p>\u4f8b\u5982\uff0c\u6211\u4eec\u60f3\u8981\u9a8c\u8bc1API\u8bf7\u6c42\u4e2d\u5e26\u6709\u4ee4\u724c\uff08token\uff09\u53c2\u6570\uff0c\u5e76\u4e14\u8fd9\u4e2a\u4ee4\u724c\u662f\u6709\u6548\u7684\uff0c\u5c31\u53ef\u4ee5\u521b\u5efa\u4e00\u4e2a\u81ea\u5b9a\u4e49\u4e2d\u95f4\u4ef6\u6765\u5b9e\u73b0\u8fd9\u4e2a\u529f\u80fd\uff1a<\/p>\n<pre>php artisan make:middleware ValidateToken<\/pre>\n<p>  \u767b\u5f55\u540e\u590d\u5236    <\/p>\n<pre>public function handle($request, Closure $next)\n{\n    $token = $request-&amp;gt;input('token');\n\n    if (! $token || ! Token::isValid($token)) {\n        return response()-&amp;gt;json([\n            'status' =&amp;gt; 'error',\n            'message' =&amp;gt; 'Invalid token provided',\n        ], 401);\n    }\n\n    return $next($request);\n}<\/pre>\n<p>  \u767b\u5f55\u540e\u590d\u5236   <\/p>\n<p>\u5728\u4e0a\u9762\u7684\u4ee3\u7801\u4e2d\uff0c\u6211\u4eec\u9996\u5148\u83b7\u53d6\u4e86\u8bf7\u6c42\u4e2d\u7684\u201ctoken\u201d\u53c2\u6570\uff0c\u5e76\u4e14\u68c0\u67e5\u4e86\u8fd9\u4e2a\u4ee4\u724c\u662f\u5426\u6709\u6548\u3002\u5982\u679c\u65e0\u6548\uff0c\u5c31\u8fd4\u56de401\u72b6\u6001\u7801\u548c\u9519\u8bef\u4fe1\u606f\u3002\u5426\u5219\uff0c\u5c31\u7ee7\u7eed\u5904\u7406\u8fd9\u4e2a\u8bf7\u6c42\u3002<\/p>\n<p>\u6700\u540e\uff0c\u6211\u4eec\u53ef\u4ee5\u5728\u8def\u7531\u5b9a\u4e49\u4e2d\u4f7f\u7528\u8fd9\u4e2a\u81ea\u5b9a\u4e49\u4e2d\u95f4\u4ef6\uff1a<\/p>\n<pre>Route::middleware(['validate_token'])-&amp;gt;group(function () {\n    Route::post('\/api\/qux', 'QuxController@create');\n});<\/pre>\n<p>  \u767b\u5f55\u540e\u590d\u5236   <\/p>\n<p>\u603b\u7ed3<\/p>\n<p>\u5728Laravel\u4e2d\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528\u5185\u7f6e\u7684\u9a8c\u8bc1\u89c4\u5219\u3001\u4e2d\u95f4\u4ef6\u548c\u81ea\u5b9a\u4e49\u4e2d\u95f4\u4ef6\u6765\u9a8c\u8bc1API\u8bf7\u6c42\uff0c\u589e\u5f3aAPI\u7684\u5b89\u5168\u6027\u3002\u540c\u65f6\uff0c\u6211\u4eec\u4e5f\u53ef\u4ee5\u6839\u636e\u5177\u4f53\u7684\u4e1a\u52a1\u9700\u6c42\uff0c\u5b9e\u73b0\u66f4\u590d\u6742\u7684\u9a8c\u8bc1\u903b\u8f91\uff0c\u4fdd\u62a4API\u63a5\u53e3\u4e0d\u88ab\u6ee5\u7528\u6216\u653b\u51fb\u3002<\/p>\n<p>\u4ee5\u4e0a\u5c31\u662flaravel\u5199api\u600e\u4e48\u9a8c\u8bc1\u7684\u8be6\u7ec6\u5185\u5bb9\uff0c\u66f4\u591a\u8bf7\u5173\u6ce8\u7c73\u4e91\u5176\u5b83\u76f8\u5173\u6587\u7ae0\uff01<\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u968f\u7740web api\u7684\u666e\u53ca\uff0capi\u7684\u5b89\u5168\u6027\u53d8\u5f97\u8d8a\u6765\u8d8a\u91cd\u8981\u3002\u5728laravel\u4e2d\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528\u5185\u7f6e\u7684\u9a8c\u8bc1\u89c4\u5219\u548c\u4e2d\u95f4\u4ef6\u6765\u5bf9api\u8bf7\u6c42\u8fdb\u884c\u9a8c\u8bc1\u548c\u4fdd\u62a4\u3002 \u4f7f\u7528Laravel\u5185\u7f6e\u7684\u9a8c\u8bc1\u89c4\u5219 Laravel\u63d0\u4f9b\u4e86\u4e00\u7cfb\u5217\u7684\u9a8c\u8bc1\u89c4\u5219\uff0c\u5982\u201crequired\u201d\uff08\u5fc5\u586b\u9879\uff09\u3001\u201cemail\u201d\uff08\u90ae\u7bb1\u683c\u5f0f\uff09\u7b49\u7b49\u3002\u6211\u4eec\u53ef\u4ee5\u5c06\u8fd9\u4e9b\u89c4\u5219\u5e94\u7528\u5230\u6211\u4eec\u7684API\u63a5\u53e3\u4e2d\uff0c\u4ece\u800c\u4fdd\u8bc1\u63a5\u53e3\u53c2\u6570\u7684\u6b63\u786e\u6027\u3002 \u4f8b\u5982\uff0c\u6211\u4eec\u60f3\u8981\u9a8c\u8bc1\u4e00\u4e2a\u6ce8\u518cAPI\u63a5\u53e3\u7684\u53c2\u6570\uff0c\u53ef\u4ee5\u4f7f\u7528\u4ee5\u4e0b\u4ee3\u7801\uff1a public function register(Request $request) { $validatedData = $request-&amp;gt;validate([ &#8216;name&#8217; =&amp;gt; &#8216;required|string|max:255&#8242;, &#8217;email&#8217; =&amp;gt; &#8216;required|string|email|max:255|unique:users&#8217;, &#8216;password&#8217; =&amp;gt; &#8216;required|string|min:8&#8217;, ]); \/\/ \u5bf9\u8bf7\u6c42\u53c2\u6570\u8fdb\u884c\u5904\u7406 \/\/ &#8230; \/\/ \u6ce8\u518c\u7528\u6237 \/\/ &#8230; } \u767b\u5f55\u540e\u590d\u5236 \u5728\u4e0a\u9762\u7684\u4ee3\u7801\u4e2d\uff0c\u6211\u4eec\u4f7f\u7528\u4e86$request-&gt;validate()\u65b9\u6cd5\u6765\u5bf9\u8bf7\u6c42\u53c2\u6570\u8fdb\u884c\u9a8c\u8bc1\u3002\u5982\u679c\u9a8c\u8bc1\u5931\u8d25\uff0cLaravel\u4f1a\u81ea\u52a8\u629b\u51fa\u4e00\u4e2aValidationException\u5f02\u5e38\uff0c\u4e4b\u540e\u6211\u4eec\u9700\u8981\u5728\u5f02\u5e38\u5904\u7406\u5668\u4e2d\u5904\u7406\u8fd9\u4e2a\u5f02\u5e38\u3002 \u4f7f\u7528Laravel\u5185\u7f6e\u7684\u4e2d\u95f4\u4ef6 Laravel\u8fd8\u63d0\u4f9b\u4e86\u5f88\u591a\u4e2d\u95f4\u4ef6\u6765\u589e\u5f3aAPI\u7684\u5b89\u5168\u6027\u3002\u4ee5\u4e0b\u662f\u4e00\u4e9b\u5e38\u7528\u7684\u4e2d\u95f4\u4ef6\uff1a auth\uff1a\u7528\u4e8e\u7528\u6237\u8ba4\u8bc1\uff0c\u53ea\u5141\u8bb8\u5df2\u767b\u5f55\u7528\u6237\u8bbf\u95ee\u63a5\u53e3\uff1b throttle\uff1a\u7528\u4e8e\u9650\u5236API\u63a5\u53e3\u7684\u8bf7\u6c42\u9891\u7387\uff0c\u907f\u514d\u88ab\u653b\u51fb\u6216\u6ee5\u7528\uff1b cors\uff1a\u7528\u4e8e\u8de8\u57df\u8d44\u6e90\u5171\u4eab\uff0c\u5141\u8bb8\u8de8\u57df\u8bf7\u6c42\uff1b csrf\uff1a\u7528\u4e8e\u9632\u6b62\u8de8\u7ad9\u8bf7\u6c42\u4f2a\u9020\u653b\u51fb\uff1b \u6211\u4eec\u53ef\u4ee5\u76f4\u63a5\u5728\u8def\u7531\u5b9a\u4e49\u4e2d\u4f7f\u7528\u8fd9\u4e9b\u4e2d\u95f4\u4ef6\uff0c\u5982\u4e0b\u6240\u793a\uff1a \/\/ \u5b9a\u4e49\u9700\u8981\u8ba4\u8bc1\u7684API\u63a5\u53e3 Route::middleware([&#8216;auth&#8217;])-&amp;gt;group(function () { Route::post(&#8216;\/api\/foo&#8217;, &#8216;FooController@create&#8217;); Route::put(&#8216;\/api\/foo\/{id}&#8217;, &#8216;FooController@update&#8217;); }); \/\/ \u5b9a\u4e49\u5141\u8bb8\u8de8\u57df\u8bbf\u95ee\u7684API\u63a5\u53e3 Route::middleware([&#8216;cors&#8217;])-&amp;gt;group(function () [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[16],"tags":[],"class_list":["post-22630","post","type-post","status-publish","format-standard","hentry","category-16"],"_links":{"self":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/22630","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/comments?post=22630"}],"version-history":[{"count":0,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/22630\/revisions"}],"wp:attachment":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/media?parent=22630"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/categories?post=22630"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/tags?post=22630"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}