{"id":25120,"date":"2024-11-21T10:34:14","date_gmt":"2024-11-21T02:34:14","guid":{"rendered":"https:\/\/fwq.ai\/blog\/25120\/"},"modified":"2024-11-21T10:34:14","modified_gmt":"2024-11-21T02:34:14","slug":"thinkphp%e5%bc%80%e5%8f%91%e7%bb%8f%e9%aa%8c%e6%80%bb%e7%bb%93%ef%bc%9a%e5%a6%82%e4%bd%95%e8%bf%9b%e8%a1%8capi%e6%96%87%e6%a1%a3%e7%94%9f%e6%88%90","status":"publish","type":"post","link":"https:\/\/fwq.ai\/blog\/25120\/","title":{"rendered":"ThinkPHP\u5f00\u53d1\u7ecf\u9a8c\u603b\u7ed3\uff1a\u5982\u4f55\u8fdb\u884cAPI\u6587\u6863\u751f\u6210"},"content":{"rendered":"

\"ThinkPHP\u5f00\u53d1\u7ecf\u9a8c\u603b\u7ed3\uff1a\u5982\u4f55\u8fdb\u884cAPI\u6587\u6863\u751f\u6210\u63d2\u56fe\"<\/p>\n

ThinkPHP \u662f\u4e00\u4e2a\u57fa\u4e8e PHP \u7684\u5f00\u6e90 Web \u5f00\u53d1\u6846\u67b6\uff0c\u88ab\u5e7f\u6cdb\u5e94\u7528\u4e8e\u5404\u7c7b Web \u5e94\u7528\u7a0b\u5e8f\u7684\u5f00\u53d1\u4e2d\u3002\u5728\u5b9e\u9645\u9879\u76ee\u4e2d\uff0c\u5982\u4f55\u751f\u6210\u6e05\u6670\u3001\u51c6\u786e\u7684 API \u6587\u6863\u662f\u5f00\u53d1\u8fc7\u7a0b\u4e2d\u4e0d\u53ef\u5ffd\u89c6\u7684\u4e00\u73af\u3002\u672c\u6587\u5c06\u603b\u7ed3\u4e00\u4e9b ThinkPHP \u5f00\u53d1\u7ecf\u9a8c\uff0c\u91cd\u70b9\u63a2\u8ba8\u5982\u4f55\u8fdb\u884c API \u6587\u6863\u751f\u6210\uff0c\u5e2e\u52a9\u5f00\u53d1\u8005\u63d0\u9ad8\u5de5\u4f5c\u6548\u7387\u548c\u4ee3\u7801\u8d28\u91cf\u3002<\/p>\n

\u4e00\u3001\u9879\u76ee\u76ee\u5f55\u7ed3\u6784<\/p>\n

\u5728\u8fdb\u884c API \u6587\u6863\u751f\u6210\u4e4b\u524d\uff0c\u9996\u5148\u9700\u8981\u5bf9\u9879\u76ee\u7684\u76ee\u5f55\u7ed3\u6784\u6709\u4e00\u5b9a\u7684\u4e86\u89e3\u3002\u901a\u5e38\u60c5\u51b5\u4e0b\uff0cThinkPHP \u9879\u76ee\u7684\u76ee\u5f55\u7ed3\u6784\u5982\u4e0b\uff1a<\/p>\n

\u251c\u2500 application\n\u2502  \u251c\u2500 common\n\u2502  \u251c\u2500 controller\n\u2502  \u251c\u2500 model\n\u2502  \u2514\u2500 ...\n\u251c\u2500 config\n\u251c\u2500 public\n\u251c\u2500 route\n\u251c\u2500 think\n\u251c\u2500 vendor\n\u2514\u2500 ...<\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 <\/p>\n
\u5176\u4e2d\uff0capplication \u76ee\u5f55\u5b58\u653e\u4e86\u5e94\u7528\u7a0b\u5e8f\u7684\u76f8\u5173\u4ee3\u7801\uff0c\u5305\u62ec\u63a7\u5236\u5668\u3001\u6a21\u578b\u7b49\uff1bconfig \u5b58\u653e\u4e86\u9879\u76ee\u7684\u914d\u7f6e\u6587\u4ef6\uff1bpublic \u76ee\u5f55\u662f Web \u670d\u52a1\u5668\u7684\u5165\u53e3\u76ee\u5f55\uff1broute \u5b58\u653e\u4e86\u8def\u7531\u914d\u7f6e\uff1bthink \u662f\u6846\u67b6\u7684\u6267\u884c\u5165\u53e3\u6587\u4ef6\uff1bvendor \u662f\u9879\u76ee\u7684\u4f9d\u8d56\u5305\u76ee\u5f55\u3002\u719f\u6089\u9879\u76ee\u76ee\u5f55\u7ed3\u6784\u6709\u52a9\u4e8e\u540e\u7eed\u7684 API \u6587\u6863\u751f\u6210\u5de5\u4f5c\u3002<\/p>\n
\u7acb\u5373\u5b66\u4e60<\/span>\u201c\u201d\uff1b<\/p>\n
\u4e8c\u3001\u6ce8\u91ca\u89c4\u8303<\/p>\n
\u5728\u8fdb\u884c API \u6587\u6863\u751f\u6210\u65f6\uff0c\u826f\u597d\u7684\u6ce8\u91ca\u89c4\u8303\u662f\u975e\u5e38\u91cd\u8981\u7684\u3002\u5728 ThinkPHP \u4e2d\uff0c\u901a\u5e38\u4f1a\u4f7f\u7528\u6ce8\u91ca\u6765\u89e3\u91ca\u63a5\u53e3\u7684\u529f\u80fd\u3001\u53c2\u6570\u3001\u8fd4\u56de\u503c\u7b49\u4fe1\u606f\u3002\u4ee5\u4e0b\u662f\u4e00\u4e9b\u5e38\u7528\u7684\u6ce8\u91ca\u89c4\u8303\u793a\u4f8b\uff1a<\/p>\n
\/**\n * \u83b7\u53d6\u7528\u6237\u4fe1\u606f\n * @param int $id \u7528\u6237ID\n * @return array \u7528\u6237\u4fe1\u606f\n *\/\npublic function getUserInfo($id)\n{\n    \/\/ \u4e1a\u52a1\u903b\u8f91\u4ee3\u7801\n}<\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 <\/p>\n
\u5728\u4e0a\u8ff0\u793a\u4f8b\u4e2d\uff0c\u6ce8\u91ca\u4e2d\u5305\u62ec\u4e86\u63a5\u53e3\u7684\u529f\u80fd\u63cf\u8ff0\u3001\u53c2\u6570\u8bf4\u660e\u3001\u8fd4\u56de\u503c\u8bf4\u660e\uff0c\u8fd9\u6837\u7684\u6ce8\u91ca\u89c4\u8303\u6709\u52a9\u4e8e\u751f\u6210\u6e05\u6670\u7684 API \u6587\u6863\u3002<\/p>\n
\u4e09\u3001\u4f7f\u7528 Swagger<\/p>\n
Swagger \u662f\u4e00\u4e2a\u5f00\u6e90\u7684 API \u89c4\u8303\u548c\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u80fd\u591f\u5e2e\u52a9\u5f00\u53d1\u8005\u5feb\u901f\u751f\u6210 API \u6587\u6863\uff0c\u5e76\u63d0\u4f9b\u4e86\u53cb\u597d\u7684 UI \u754c\u9762\u3002\u5728 ThinkPHP \u9879\u76ee\u4e2d\uff0c\u53ef\u4ee5\u901a\u8fc7\u5b89\u88c5 swagger-php \u63d2\u4ef6\u6765\u5b9e\u73b0 API \u6587\u6863\u7684\u81ea\u52a8\u751f\u6210\u3002\u9996\u5148\uff0c\u9700\u8981\u5728\u9879\u76ee\u4e2d\u5b89\u88c5 swagger-php\uff1a<\/p>\n
composer require zircote\/swagger-php<\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 <\/p>\n
\u5b89\u88c5\u5b8c\u6210\u540e\uff0c\u53ef\u4ee5\u5728\u63a7\u5236\u5668\u7684\u6ce8\u91ca\u4e2d\u4f7f\u7528 Swagger \u7684\u6ce8\u89e3\u6807\u8bb0\uff1a<\/p>\n
\/**\n * @SWGGet(\n *     path=\"\/api\/user\/{id}\",\n *     @SWGParameter(name=\"id\", in=\"path\", required=true, type=\"integer\"),\n *     @SWGResponse(response=\"200\", description=\"\u7528\u6237\u4fe1\u606f\")\n * )\n *\/\npublic function getUserInfo($id)\n{\n    \/\/ \u4e1a\u52a1\u903b\u8f91\u4ee3\u7801\n}<\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 <\/p>\n
\u5728\u6ce8\u91ca\u4e2d\u4f7f\u7528\u4e86 @SWGGet \u6765\u6807\u8bb0\u63a5\u53e3\u7684\u8bf7\u6c42\u65b9\u5f0f\uff0c@SWGParameter \u6807\u8bb0\u4e86\u63a5\u53e3\u7684\u53c2\u6570\uff0c@SWGResponse \u6807\u8bb0\u4e86\u63a5\u53e3\u7684\u8fd4\u56de\u7ed3\u679c\u3002\u4f7f\u7528\u8fd9\u6837\u7684\u6ce8\u89e3\u540e\uff0c\u53ef\u4ee5\u901a\u8fc7\u8fd0\u884c php think swagger:export \u547d\u4ee4\uff0c\u81ea\u52a8\u751f\u6210 API \u6587\u6863\u3002<\/p>\n
\u56db\u3001\u6574\u5408\u6587\u6863\u751f\u6210\u5de5\u5177<\/p>\n
\u9664\u4e86\u4f7f\u7528 Swagger\uff0c\u8fd8\u53ef\u4ee5\u7ed3\u5408\u5176\u4ed6\u6587\u6863\u751f\u6210\u5de5\u5177\u6765\u751f\u6210 API \u6587\u6863\u3002\u4f8b\u5982\uff0c\u53ef\u4ee5\u4f7f\u7528 apigen\u3001phpDocumentor \u7b49\u5de5\u5177\uff0c\u5b83\u4eec\u90fd\u80fd\u591f\u6839\u636e\u4ee3\u7801\u4e2d\u7684\u6ce8\u91ca\u81ea\u52a8\u751f\u6210 API \u6587\u6863\u3002\u5728\u4f7f\u7528\u8fd9\u4e9b\u5de5\u5177\u65f6\uff0c\u9700\u8981\u6839\u636e\u5de5\u5177\u7684\u5177\u4f53\u6587\u6863\u6765\u914d\u7f6e\u548c\u751f\u6210 API \u6587\u6863\u3002<\/p>\n
\u4e94\u3001\u6301\u7eed\u7ef4\u62a4\u548c\u66f4\u65b0<\/p>\n
\u751f\u6210\u4e86 API \u6587\u6863\u4e4b\u540e\uff0c\u5e76\u4e0d\u4ee3\u8868\u5de5\u4f5c\u5c31\u5b8c\u6210\u4e86\u3002API \u6587\u6863\u662f\u4e00\u4e2a\u4e0d\u65ad\u66f4\u65b0\u7684\u8fc7\u7a0b\uff0c\u968f\u7740\u9879\u76ee\u7684\u8fed\u4ee3\u548c\u529f\u80fd\u7684\u589e\u52a0\uff0cAPI \u6587\u6863\u4e5f\u9700\u8981\u4e0d\u65ad\u66f4\u65b0\u548c\u7ef4\u62a4\u3002\u5f00\u53d1\u8005\u5e94\u5f53\u517b\u6210\u826f\u597d\u7684\u6587\u6863\u7f16\u5199\u548c\u66f4\u65b0\u4e60\u60ef\uff0c\u786e\u4fdd API \u6587\u6863\u4e0e\u5b9e\u9645\u63a5\u53e3\u4fdd\u6301\u4e00\u81f4\u3002<\/p>\n
\u603b\u7ed3<\/p>\n
API \u6587\u6863\u7684\u751f\u6210\u662f\u5f00\u53d1\u5de5\u4f5c\u4e2d\u91cd\u8981\u7684\u4e00\u73af\uff0c\u5b83\u4e0d\u4ec5\u80fd\u591f\u5e2e\u52a9\u56e2\u961f\u6210\u5458\u7406\u89e3\u63a5\u53e3\u7684\u529f\u80fd\u548c\u4f7f\u7528\u65b9\u6cd5\uff0c\u8fd8\u80fd\u591f\u63d0\u9ad8\u9879\u76ee\u7684\u53ef\u7ef4\u62a4\u6027\u548c\u53ef\u6269\u5c55\u6027\u3002\u5728 ThinkPHP \u5f00\u53d1\u4e2d\uff0c\u901a\u8fc7\u5408\u7406\u7684\u6ce8\u91ca\u89c4\u8303\u548c\u6587\u6863\u751f\u6210\u5de5\u5177\u7684\u4f7f\u7528\uff0c\u53ef\u4ee5\u8f7b\u677e\u5730\u751f\u6210\u6e05\u6670\u3001\u51c6\u786e\u7684 API \u6587\u6863\uff0c\u4e3a\u9879\u76ee\u5f00\u53d1\u548c\u7ef4\u62a4\u63d0\u4f9b\u6709\u529b\u7684\u652f\u6301\u3002\u5e0c\u671b\u672c\u6587\u63d0\u4f9b\u7684\u7ecf\u9a8c\u603b\u7ed3\u5bf9 ThinkPHP \u5f00\u53d1\u8005\u6709\u6240\u5e2e\u52a9\u3002<\/p>\n
\u4ee5\u4e0a\u5c31\u662fThinkPHP\u5f00\u53d1\u7ecf\u9a8c\u603b\u7ed3\uff1a\u5982\u4f55\u8fdb\u884cAPI\u6587\u6863\u751f\u6210\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":"
ThinkPHP \u662f\u4e00\u4e2a\u57fa\u4e8e PHP \u7684\u5f00\u6e90 Web \u5f00\u53d1\u6846\u67b6\uff0c\u88ab\u5e7f\u6cdb\u5e94\u7528\u4e8e\u5404\u7c7b Web \u5e94\u7528\u7a0b\u5e8f\u7684\u5f00\u53d1\u4e2d\u3002\u5728\u5b9e\u9645\u9879\u76ee\u4e2d\uff0c\u5982\u4f55\u751f\u6210\u6e05\u6670\u3001\u51c6\u786e\u7684 API \u6587\u6863\u662f\u5f00\u53d1\u8fc7\u7a0b\u4e2d\u4e0d\u53ef\u5ffd\u89c6\u7684\u4e00\u73af\u3002\u672c\u6587\u5c06\u603b\u7ed3\u4e00\u4e9b ThinkPHP \u5f00\u53d1\u7ecf\u9a8c\uff0c\u91cd\u70b9\u63a2\u8ba8\u5982\u4f55\u8fdb\u884c API \u6587\u6863\u751f\u6210\uff0c\u5e2e\u52a9\u5f00\u53d1\u8005\u63d0\u9ad8\u5de5\u4f5c\u6548\u7387\u548c\u4ee3\u7801\u8d28\u91cf\u3002 \u4e00\u3001\u9879\u76ee\u76ee\u5f55\u7ed3\u6784 \u5728\u8fdb\u884c API \u6587\u6863\u751f\u6210\u4e4b\u524d\uff0c\u9996\u5148\u9700\u8981\u5bf9\u9879\u76ee\u7684\u76ee\u5f55\u7ed3\u6784\u6709\u4e00\u5b9a\u7684\u4e86\u89e3\u3002\u901a\u5e38\u60c5\u51b5\u4e0b\uff0cThinkPHP \u9879\u76ee\u7684\u76ee\u5f55\u7ed3\u6784\u5982\u4e0b\uff1a \u251c\u2500 application \u2502 \u251c\u2500 common \u2502 \u251c\u2500 controller \u2502 \u251c\u2500 model \u2502 \u2514\u2500 … \u251c\u2500 config \u251c\u2500 public \u251c\u2500 route \u251c\u2500 think \u251c\u2500 vendor \u2514\u2500 … \u767b\u5f55\u540e\u590d\u5236 \u5176\u4e2d\uff0capplication \u76ee\u5f55\u5b58\u653e\u4e86\u5e94\u7528\u7a0b\u5e8f\u7684\u76f8\u5173\u4ee3\u7801\uff0c\u5305\u62ec\u63a7\u5236\u5668\u3001\u6a21\u578b\u7b49\uff1bconfig \u5b58\u653e\u4e86\u9879\u76ee\u7684\u914d\u7f6e\u6587\u4ef6\uff1bpublic \u76ee\u5f55\u662f Web \u670d\u52a1\u5668\u7684\u5165\u53e3\u76ee\u5f55\uff1broute \u5b58\u653e\u4e86\u8def\u7531\u914d\u7f6e\uff1bthink \u662f\u6846\u67b6\u7684\u6267\u884c\u5165\u53e3\u6587\u4ef6\uff1bvendor \u662f\u9879\u76ee\u7684\u4f9d\u8d56\u5305\u76ee\u5f55\u3002\u719f\u6089\u9879\u76ee\u76ee\u5f55\u7ed3\u6784\u6709\u52a9\u4e8e\u540e\u7eed\u7684 […]<\/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-25120","post","type-post","status-publish","format-standard","hentry","category-16"],"_links":{"self":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/25120","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=25120"}],"version-history":[{"count":0,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/25120\/revisions"}],"wp:attachment":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/media?parent=25120"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/categories?post=25120"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/tags?post=25120"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}