{"id":23308,"date":"2024-11-21T08:14:28","date_gmt":"2024-11-21T00:14:28","guid":{"rendered":"https:\/\/fwq.ai\/blog\/23308\/"},"modified":"2024-11-21T08:14:28","modified_gmt":"2024-11-21T00:14:28","slug":"laravel%e5%bc%80%e5%8f%91%ef%bc%9a%e5%a6%82%e4%bd%95%e4%bd%bf%e7%94%a8laravel-swagger%e7%94%9f%e6%88%90api%e6%96%87%e6%a1%a3%ef%bc%9f","status":"publish","type":"post","link":"https:\/\/fwq.ai\/blog\/23308\/","title":{"rendered":"Laravel\u5f00\u53d1\uff1a\u5982\u4f55\u4f7f\u7528Laravel Swagger\u751f\u6210API\u6587\u6863\uff1f"},"content":{"rendered":"<p>\u5f00\u53d1\uff1a\u5982\u4f55\u4f7f\u7528laravel swagger\u751f\u6210api\u6587\u6863\uff1f<\/p>\n<p>\u5728\u5f00\u53d1 Web \u5e94\u7528\u7a0b\u5e8f\u65f6\uff0c\u5904\u7406 API \u6587\u6863\u5f80\u5f80\u662f\u4e00\u9879\u7e41\u7410\u4f46\u5fc5\u4e0d\u53ef\u5c11\u7684\u4efb\u52a1\u3002\u4f7f\u7528 Swagger \u53ef\u4ee5\u81ea\u52a8\u751f\u6210 API \u6587\u6863\u5e76\u4f7f\u5176\u53ef\u89c6\u5316\u3002\u5728 Laravel \u5f00\u53d1\u4e2d\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528 Laravel Swagger \u6269\u5c55\u5305\u6765\u8f7b\u677e\u5730\u751f\u6210 Swagger API \u6587\u6863\u3002\u672c\u6587\u5c06\u6307\u5f15\u60a8\u5982\u4f55\u5728 Laravel \u4e2d\u4f7f\u7528 Laravel Swagger\u3002<\/p>\n<ol>\n<li>\u5b89\u88c5 Laravel Swagger<\/li>\n<\/ol>\n<p>\u4f7f\u7528 Composer \u5b89\u88c5 Laravel Swagger \u6269\u5c55\u5305\uff1a<\/p>\n<pre>composer require darkaonline\/l5-swagger<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<ol>\n<li>\u914d\u7f6e Laravel Swagger<\/li>\n<\/ol>\n<p>Laravel Swagger \u4f9d\u8d56\u4e8e Swagger UI\uff0c\u56e0\u6b64\u6211\u4eec\u9700\u8981\u5c06 Swagger UI \u7684\u8d44\u6e90\u53d1\u5e03\u5230 Laravel \u7684\u516c\u5171\u76ee\u5f55\u4e2d\uff0c\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u5b8c\u6210\u53d1\u5e03\uff1a<\/p>\n<pre>php artisan vendor:publish --provider \"L5SwaggerL5SwaggerServiceProvider\"<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<p>\u6267\u884c\u53d1\u5e03\u547d\u4ee4\u540e\uff0c\u5c06\u4f1a\u5728 public\/vendor \u76ee\u5f55\u4e0b\u770b\u5230 swagger-ui \u76ee\u5f55\uff0c\u8fd9\u4e2a\u76ee\u5f55\u4e2d\u5305\u542b\u4e86 Swagger UI \u7684\u6240\u6709\u8d44\u6e90\u3002<\/p>\n<p>\u63a5\u4e0b\u6765\uff0c\u5728 Laravel \u7684\u914d\u7f6e\u6587\u4ef6 config\/app.php \u4e2d\u6dfb\u52a0\u4ee5\u4e0b\u884c\uff1a<\/p>\n<pre>'providers' =&amp;gt; [\n    ...\n    L5SwaggerL5SwaggerServiceProvider::class,\n],\n\n'aliases' =&amp;gt; [\n    ...\n    'Swagger' =&amp;gt; L5SwaggerFacadesL5Swagger::class,\n],<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<ol>\n<li>\u6dfb\u52a0 Swagger \u6ce8\u91ca<\/li>\n<\/ol>\n<p>\u4e3a\u4e86\u544a\u8bc9 Laravel Swagger \u6ca1\u6709\u63a8\u65ad\u7684 API \u683c\u5f0f\uff0c\u6211\u4eec\u9700\u8981\u5728\u4ee3\u7801\u4e2d\u6dfb\u52a0 Swagger \u6ce8\u91ca\u3002\u8fd9\u4e9b\u6ce8\u91ca\u53ef\u4ee5\u8ba9 Laravel Swagger \u81ea\u52a8\u89e3\u6790\u60a8\u7684 API\uff0c\u5e76\u751f\u6210\u5bf9\u5e94\u7684\u6587\u6863\u3002<\/p>\n<pre>\/**\n * @OAGet(\n *      path=\"\/users\",\n *      operationId=\"getUsersList\",\n *      tags={\"Users\"},\n *      summary=\"Get list of registered users\",\n *      description=\"Returns list of users\",\n *      @OAResponse(response=\"200\", description=\"successful operation\"),\n *      @OAResponse(response=401, description=\"Unauthorized\"),\n *      @OAResponse(response=403, description=\"Forbidden\"),\n *      @OAResponse(response=404, description=\"Not Found\"),\n *      @OAResponse(response=500, description=\"Internal Server Error\")\n *     )\n *\/<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<p>\u5728\u4e0a\u9762\u7684\u793a\u4f8b\u4e2d\uff0c\u6211\u4eec\u4f7f\u7528 @OAGet \u6ce8\u91ca\u8868\u793a\u8fd9\u662f\u4e00\u4e2a GET \u8bf7\u6c42\u3002path \u6ce8\u91ca\u5b9a\u4e49 API \u7684\u8def\u5f84\u3002tags \u548c summary \u6ce8\u91ca\u7528\u4e8e\u5728 Swagger \u6587\u6863\u4e2d\u663e\u793a\u6458\u8981\u548c\u6807\u7b7e\u3002\u6700\u540e\uff0c@OAResponse \u6ce8\u91ca\u793a\u4f8b\u4e86\u53ef\u80fd\u7684\u54cd\u5e94\u72b6\u6001\u3002<\/p>\n<ol>\n<li>\u5728 Laravel \u4e2d\u67e5\u770b Swagger \u6587\u6863<\/li>\n<\/ol>\n<p>\u5728\u5b8c\u6210\u6240\u6709\u5148\u524d\u7684\u6b65\u9aa4\u4e4b\u540e\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528\u4ee5\u4e0b URL \u6765\u67e5\u770b Laravel Swagger \u6587\u6863\uff1a<\/p>\n<pre>http:\/\/your-app.dev\/api\/documentation<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<p>\uff08\u8bf7\u6ce8\u610f\uff0c\u5982\u679c\u60a8\u4f7f\u7528\u7684\u662f Laravel 5.4 \u6216\u4ee5\u4e0a\u7248\u672c\uff0c\u5219\u65e0\u9700\u5b9a\u4e49 .dev\uff0c\u8bf7\u6539\u4e3a\u4f7f\u7528 .test \u6216\u5176\u4ed6\u672c\u5730\u57df\u540d\uff09<\/p>\n<p>\u542f\u52a8 Laravel \u7684\u5f00\u53d1\u670d\u52a1\u5668\uff0c\u5e76\u8bbf\u95ee\u4e0a\u9762\u7684 URL\uff0c\u60a8\u5e94\u8be5\u80fd\u591f\u5728\u6d4f\u89c8\u5668\u4e2d\u770b\u5230\u81ea\u52a8\u751f\u6210\u7684 Swagger \u6587\u6863\u3002<\/p>\n<p>\u5728 Swagger \u6587\u6863\u4e2d\uff0c\u60a8\u53ef\u4ee5\u67e5\u770b\u5b9a\u4e49\u7684 API\uff0c\u6839\u636e API \u4e2d\u6dfb\u52a0\u7684 Swagger \u6ce8\u91ca\u6765\u6d4b\u8bd5 API\uff0c\u5e76\u67e5\u770b\u53ef\u80fd\u7684\u54cd\u5e94\u72b6\u6001\u3002<\/p>\n<p>\u603b\u7ed3<\/p>\n<p>\u5728\u672c\u6587\u4e2d\uff0c\u6211\u4eec\u4e86\u89e3\u4e86\u5982\u4f55\u4f7f\u7528 Laravel Swagger \u6269\u5c55\u5305\u8f7b\u677e\u751f\u6210 Swagger API \u6587\u6863\u3002\u9996\u5148\uff0c\u6211\u4eec\u5b89\u88c5\u4e86 Laravel Swagger\uff0c\u7136\u540e\u542f\u52a8 Swagger\uff0c\u5e76\u4e3a API \u6dfb\u52a0\u4e86 Swagger \u6ce8\u91ca\u3002\u6700\u540e\uff0c\u6211\u4eec\u67e5\u770b\u4e86 Laravel Swagger \u751f\u6210\u7684\u6587\u6863\u3002<\/p>\n<p>\u4f7f\u7528 Laravel Swagger \u53ef\u4ee5\u5927\u5927\u51cf\u8f7b\u624b\u52a8\u7f16\u5199 API \u6587\u6863\u7684\u8d1f\u62c5\uff0c\u907f\u514d\u4e86\u53ef\u80fd\u7684\u9519\u8bef\u548c\u4e0d\u4e00\u81f4\u6027\u3002\u901a\u8fc7\u4f7f\u7528 Swagger UI\uff0c\u6211\u4eec\u53ef\u4ee5\u66f4\u65b9\u4fbf\u5730\u67e5\u770b\u548c\u6d4b\u8bd5 API\uff0c\u540c\u65f6\u63d0\u4f9b\u4e86\u5bf9\u5f00\u53d1\u4eba\u5458\u53cb\u597d\u7684\u63a5\u53e3\u3002<\/p>\n<p>\u4ee5\u4e0a\u5c31\u662fLaravel\u5f00\u53d1\uff1a\u5982\u4f55\u4f7f\u7528Laravel Swagger\u751f\u6210API\u6587\u6863\uff1f\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>\u5f00\u53d1\uff1a\u5982\u4f55\u4f7f\u7528laravel swagger\u751f\u6210api\u6587\u6863\uff1f \u5728\u5f00\u53d1 Web \u5e94\u7528\u7a0b\u5e8f\u65f6\uff0c\u5904\u7406 API \u6587\u6863\u5f80\u5f80\u662f\u4e00\u9879\u7e41\u7410\u4f46\u5fc5\u4e0d\u53ef\u5c11\u7684\u4efb\u52a1\u3002\u4f7f\u7528 Swagger \u53ef\u4ee5\u81ea\u52a8\u751f\u6210 API \u6587\u6863\u5e76\u4f7f\u5176\u53ef\u89c6\u5316\u3002\u5728 Laravel \u5f00\u53d1\u4e2d\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528 Laravel Swagger \u6269\u5c55\u5305\u6765\u8f7b\u677e\u5730\u751f\u6210 Swagger API \u6587\u6863\u3002\u672c\u6587\u5c06\u6307\u5f15\u60a8\u5982\u4f55\u5728 Laravel \u4e2d\u4f7f\u7528 Laravel Swagger\u3002 \u5b89\u88c5 Laravel Swagger \u4f7f\u7528 Composer \u5b89\u88c5 Laravel Swagger \u6269\u5c55\u5305\uff1a composer require darkaonline\/l5-swagger \u767b\u5f55\u540e\u590d\u5236 \u914d\u7f6e Laravel Swagger Laravel Swagger \u4f9d\u8d56\u4e8e Swagger UI\uff0c\u56e0\u6b64\u6211\u4eec\u9700\u8981\u5c06 Swagger UI \u7684\u8d44\u6e90\u53d1\u5e03\u5230 Laravel \u7684\u516c\u5171\u76ee\u5f55\u4e2d\uff0c\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u5b8c\u6210\u53d1\u5e03\uff1a php artisan vendor:publish &#8211;provider &#8220;L5SwaggerL5SwaggerServiceProvider&#8221; \u767b\u5f55\u540e\u590d\u5236 [&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-23308","post","type-post","status-publish","format-standard","hentry","category-16"],"_links":{"self":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/23308","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=23308"}],"version-history":[{"count":0,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/23308\/revisions"}],"wp:attachment":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/media?parent=23308"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/categories?post=23308"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/tags?post=23308"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}