{"id":23256,"date":"2024-11-21T10:50:10","date_gmt":"2024-11-21T02:50:10","guid":{"rendered":"https:\/\/fwq.ai\/blog\/23256\/"},"modified":"2024-11-21T10:50:10","modified_gmt":"2024-11-21T02:50:10","slug":"%e5%a6%82%e4%bd%95%e4%bd%bf%e7%94%a8thinkphp6%e8%bf%9b%e8%a1%8capi%e6%8e%a5%e5%8f%a3%e6%96%87%e6%a1%a3%e7%ae%a1%e7%90%86%ef%bc%9f","status":"publish","type":"post","link":"https:\/\/fwq.ai\/blog\/23256\/","title":{"rendered":"\u5982\u4f55\u4f7f\u7528ThinkPHP6\u8fdb\u884cAPI\u63a5\u53e3\u6587\u6863\u7ba1\u7406\uff1f"},"content":{"rendered":"<p>\u968f\u7740\u4e92\u8054\u7f51\u7684\u53d1\u5c55\uff0cweb api\uff08\u5e94\u7528\u7a0b\u5e8f\u63a5\u53e3\uff09\u8d8a\u6765\u8d8a\u5e38\u89c1\uff0c\u4e5f\u8d8a\u6765\u8d8a\u91cd\u8981\u3002\u800c\u5bf9\u4e8e\u4e00\u4e2aweb api\u7684\u63d0\u4f9b\u8005\u800c\u8a00\uff0c\u7f16\u5199\u5b8c\u6574\u4e14\u6613\u4e8e\u7406\u89e3\u7684api\u6587\u6863\u662f\u975e\u5e38\u6709\u5fc5\u8981\u7684\u3002\u800c\u76ee\u524d\uff0c\u6709\u8bb8\u591a\u5de5\u5177\u53ef\u4ee5\u8f7b\u677e\u5730\u751f\u6210api\u6587\u6863\uff0c\u5176\u4e2d\u6700\u6d41\u884c\u7684\u662fswagger\u3002\u4f46\u5728\u672c\u6587\u4e2d\uff0c\u6211\u5c06\u91cd\u70b9\u4ecb\u7ecd\u5982\u4f55\u4f7f\u75286\u6846\u67b6\u4e2d\u63d0\u4f9b\u7684api\u63a5\u53e3\u6587\u6863\u7ba1\u7406\u6765\u7ba1\u7406api\u6587\u6863\u3002<\/p>\n<ol>\n<li>\u5b89\u88c5\u6587\u6863\u7ba1\u7406\u6269\u5c55<\/li>\n<\/ol>\n<p>\u9996\u5148\uff0c\u6211\u4eec\u9700\u8981\u5728ThinkPHP6\u7684\u9879\u76ee\u4e2d\u5b89\u88c5API\u6587\u6863\u7ba1\u7406\u6269\u5c55\uff0c\u5b83\u88ab\u79f0\u4e3a&#8221;topthink\/think-apidoc&#8221;\u3002\u4f60\u53ef\u4ee5\u5728\u9879\u76ee\u6839\u76ee\u5f55\u4e0b\u4f7f\u7528Composer\u547d\u4ee4\u884c\u5de5\u5177\u8fdb\u884c\u5b89\u88c5\uff1a<\/p>\n<pre>composer require topthink\/think-apidoc<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<ol>\n<li>\u7f16\u5199API\u63a5\u53e3\u6587\u6863<\/li>\n<\/ol>\n<p>\u5b89\u88c5\u5b8c\u6210\u540e\uff0c\u6211\u4eec\u5c31\u53ef\u4ee5\u5f00\u59cb\u7f16\u5199API\u63a5\u53e3\u6587\u6863\u4e86\u3002\u5728ThinkPHP6\u4e2d\uff0c\u6211\u4eec\u53ef\u4ee5\u5728\u63a7\u5236\u5668\u7684\u65b9\u6cd5\u4e2d\u4f7f\u7528\u6ce8\u91ca\u7684\u65b9\u5f0f\u6765\u7f16\u5199API\u63a5\u53e3\u6587\u6863\u3002\u4f8b\u5982\uff1a<\/p>\n<pre>\/**\n * \u83b7\u53d6\u7528\u6237\u4fe1\u606f\n *\n * @ApiTitle    (\u83b7\u53d6\u7528\u6237\u4fe1\u606f)\n * @ApiSummary  (\u901a\u8fc7\u7528\u6237ID\u83b7\u53d6\u7528\u6237\u4fe1\u606f)\n * @ApiMethod   (GET)\n * @ApiRoute    (\/user\/:id)\n * @ApiParams   (name=\"id\", type=\"integer\", required=true, description=\"\u7528\u6237ID\")\n * @ApiReturn   ({\"code\": 200, \"msg\": \"success\", \"data\": {\"id\": 1, \"name\": \"\u5f20\u4e09\", \"age\": 18}})\n * @ApiHeaders  (name=\"Authorization\", type=\"string\", required=true, description=\"\u7528\u6237\u6388\u6743Token\")\n *\/\npublic function getUserInfo($id)\n{\n    \/\/ TODO: \u83b7\u53d6\u7528\u6237\u4fe1\u606f\u7684\u903b\u8f91\n}<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<p>\u4e0a\u8ff0\u6ce8\u91ca\u4e2d\uff0c\u6211\u4eec\u4f7f\u7528\u4e86\u4e00\u4e9b\u4e0d\u540c\u7684\u6ce8\u89e3\u6765\u63cf\u8ff0API\u63a5\u53e3\uff1a<\/p>\n<ul>\n<li>@ApiTitle\uff1a\u63a5\u53e3\u540d\u79f0<\/li>\n<li>@ApiSummary\uff1a\u63a5\u53e3\u7b80\u4ecb<\/li>\n<li>@ApiMethod\uff1a\u8bf7\u6c42\u65b9\u6cd5\uff08GET\u3001POST\u3001PUT\u7b49\uff09<\/li>\n<li>@ApiRoute\uff1a\u63a5\u53e3\u8def\u7531\uff08\u4f8b\u5982&#8221;\/user\/:id&#8221;\uff0c\u5176\u4e2d&#8221;:id&#8221;\u8868\u793a\u52a8\u6001\u53c2\u6570\uff09<\/li>\n<li>@ApiParams\uff1a\u63a5\u53e3\u53c2\u6570\uff0c\u5176\u4e2d\u5305\u62ec\u53c2\u6570\u540d\u79f0\u3001\u53c2\u6570\u7c7b\u578b\u3001\u662f\u5426\u5fc5\u586b\u4ee5\u53ca\u53c2\u6570\u8bf4\u660e\u7b49<\/li>\n<li>@ApiReturn\uff1a\u63a5\u53e3\u8fd4\u56de\u503c\uff0c\u5305\u62ec\u8fd4\u56de\u503c\u7684\u683c\u5f0f\u4ee5\u53ca\u8fd4\u56de\u503c\u7684\u8bf4\u660e<\/li>\n<li>@ApiHeaders\uff1a\u63a5\u53e3\u5934\u90e8\u4fe1\u606f\uff08\u4f8b\u5982Authorization\uff09<\/li>\n<\/ul>\n<p>\u6709\u4e86\u4e0a\u8ff0\u6ce8\u91ca\uff0c\u6211\u4eec\u5c31\u80fd\u591f\u6e05\u6670\u5730\u63cf\u8ff0\u4e00\u4e2aAPI\u63a5\u53e3\u7684\u57fa\u672c\u4fe1\u606f\u4e86\u3002<\/p>\n<p><span>\u7acb\u5373\u5b66\u4e60<\/span>\u201c\u201d\uff1b<\/p>\n<ol>\n<li>\u751f\u6210API\u6587\u6863<\/li>\n<\/ol>\n<p>\u7f16\u5199\u5b8cAPI\u63a5\u53e3\u6587\u6863\u4e4b\u540e\uff0c\u6211\u4eec\u5c31\u53ef\u4ee5\u4f7f\u7528ThinkPHP6\u63d0\u4f9b\u7684\u547d\u4ee4\u884c\u5de5\u5177\u751f\u6210API\u6587\u6863\u4e86\u3002\u53ea\u9700\u8981\u5728\u9879\u76ee\u6839\u76ee\u5f55\u4e2d\uff0c\u8fd0\u884c\u4ee5\u4e0b\u547d\u4ee4\u5373\u53ef\uff1a<\/p>\n<pre>php think apidoc --module api --path .\/public\/apidoc --type json<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<p>\u4e0a\u8ff0\u547d\u4ee4\u4e2d\uff0c\u6211\u4eec\u6307\u5b9a\u4e86apido\u7684\u5b58\u50a8\u8def\u5f84\u4ee5\u53ca\u751f\u6210\u7684\u6587\u6863\u7c7b\u578b\uff08\u8fd9\u91cc\u9009\u62e9\u7684\u662fjson\u683c\u5f0f\uff09\u3002\u6ce8\u610f\uff0c\u6211\u4eec\u8fd8\u6307\u5b9a\u4e86&#8211;module\u53c2\u6570\u4e3a&#8221;api&#8221;\uff0c\u8fd9\u610f\u5473\u7740\u6211\u4eec\u4ec5\u751f\u6210&#8221;api&#8221;\u6a21\u5757\u7684API\u6587\u6863\u3002\u5728\u5b9e\u9645\u5e94\u7528\u4e2d\uff0c\u53ef\u4ee5\u6839\u636e\u9700\u8981\u8fdb\u884c\u9009\u62e9\u3002<\/p>\n<p>\u8fd0\u884c\u4e0a\u8ff0\u547d\u4ee4\u540e\uff0c\u6211\u4eec\u5c31\u53ef\u4ee5\u5728\u6307\u5b9a\u7684\u5b58\u50a8\u8def\u5f84\u4e2d\u627e\u5230\u751f\u6210\u7684API\u6587\u6863\u3002\u6b64\u65f6\uff0c\u6211\u4eec\u53ef\u4ee5\u5c06\u5b83\u4eec\u4f20\u9012\u7ed9\u63a5\u53e3\u4f7f\u7528\u8005\uff0c\u65b9\u4fbf\u4ed6\u4eec\u4e86\u89e3API\u63a5\u53e3\u7684\u57fa\u672c\u4fe1\u606f\u3002<\/p>\n<p>\u601d\u8003\u9898\uff1a<\/p>\n<p>\u5982\u679c\u4f60\u5728\u4e00\u4e2a\u5df2\u6709\u7684\u9879\u76ee\u4e2d\uff0c\u4f7f\u7528\u6587\u6863\u7ba1\u7406\u6269\u5c55\uff0c\u5728\u5bf9\u5e94\u7684\u63a7\u5236\u5668\u548c\u65b9\u6cd5\u65b9\u6cd5\u90fd\u52a0\u4e0a\u4e86\u6ce8\u91ca\uff0c\u6b64\u65f6\u4f60\u518d\u6267\u884c\u7b2c\u4e09\u6b65\u7684\u64cd\u4f5c\uff0c\u4f60\u671f\u671bAPI\u63a5\u53e3\u6587\u6863\u7684\u751f\u6210\u7ed3\u679c\u957f\u6210\u4ec0\u4e48\u6837\u5b50\uff1f<\/p>\n<p>\u4ee5\u4e0a\u5c31\u662f\u5982\u4f55\u4f7f\u7528ThinkPHP6\u8fdb\u884cAPI\u63a5\u53e3\u6587\u6863\u7ba1\u7406\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>\u968f\u7740\u4e92\u8054\u7f51\u7684\u53d1\u5c55\uff0cweb api\uff08\u5e94\u7528\u7a0b\u5e8f\u63a5\u53e3\uff09\u8d8a\u6765\u8d8a\u5e38\u89c1\uff0c\u4e5f\u8d8a\u6765\u8d8a\u91cd\u8981\u3002\u800c\u5bf9\u4e8e\u4e00\u4e2aweb api\u7684\u63d0\u4f9b\u8005\u800c\u8a00\uff0c\u7f16\u5199\u5b8c\u6574\u4e14\u6613\u4e8e\u7406\u89e3\u7684api\u6587\u6863\u662f\u975e\u5e38\u6709\u5fc5\u8981\u7684\u3002\u800c\u76ee\u524d\uff0c\u6709\u8bb8\u591a\u5de5\u5177\u53ef\u4ee5\u8f7b\u677e\u5730\u751f\u6210api\u6587\u6863\uff0c\u5176\u4e2d\u6700\u6d41\u884c\u7684\u662fswagger\u3002\u4f46\u5728\u672c\u6587\u4e2d\uff0c\u6211\u5c06\u91cd\u70b9\u4ecb\u7ecd\u5982\u4f55\u4f7f\u75286\u6846\u67b6\u4e2d\u63d0\u4f9b\u7684api\u63a5\u53e3\u6587\u6863\u7ba1\u7406\u6765\u7ba1\u7406api\u6587\u6863\u3002 \u5b89\u88c5\u6587\u6863\u7ba1\u7406\u6269\u5c55 \u9996\u5148\uff0c\u6211\u4eec\u9700\u8981\u5728ThinkPHP6\u7684\u9879\u76ee\u4e2d\u5b89\u88c5API\u6587\u6863\u7ba1\u7406\u6269\u5c55\uff0c\u5b83\u88ab\u79f0\u4e3a&#8221;topthink\/think-apidoc&#8221;\u3002\u4f60\u53ef\u4ee5\u5728\u9879\u76ee\u6839\u76ee\u5f55\u4e0b\u4f7f\u7528Composer\u547d\u4ee4\u884c\u5de5\u5177\u8fdb\u884c\u5b89\u88c5\uff1a composer require topthink\/think-apidoc \u767b\u5f55\u540e\u590d\u5236 \u7f16\u5199API\u63a5\u53e3\u6587\u6863 \u5b89\u88c5\u5b8c\u6210\u540e\uff0c\u6211\u4eec\u5c31\u53ef\u4ee5\u5f00\u59cb\u7f16\u5199API\u63a5\u53e3\u6587\u6863\u4e86\u3002\u5728ThinkPHP6\u4e2d\uff0c\u6211\u4eec\u53ef\u4ee5\u5728\u63a7\u5236\u5668\u7684\u65b9\u6cd5\u4e2d\u4f7f\u7528\u6ce8\u91ca\u7684\u65b9\u5f0f\u6765\u7f16\u5199API\u63a5\u53e3\u6587\u6863\u3002\u4f8b\u5982\uff1a \/** * \u83b7\u53d6\u7528\u6237\u4fe1\u606f * * @ApiTitle (\u83b7\u53d6\u7528\u6237\u4fe1\u606f) * @ApiSummary (\u901a\u8fc7\u7528\u6237ID\u83b7\u53d6\u7528\u6237\u4fe1\u606f) * @ApiMethod (GET) * @ApiRoute (\/user\/:id) * @ApiParams (name=&#8221;id&#8221;, type=&#8221;integer&#8221;, required=true, description=&#8221;\u7528\u6237ID&#8221;) * @ApiReturn ({&#8220;code&#8221;: 200, &#8220;msg&#8221;: &#8220;success&#8221;, &#8220;data&#8221;: {&#8220;id&#8221;: 1, &#8220;name&#8221;: &#8220;\u5f20\u4e09&#8221;, &#8220;age&#8221;: 18}}) * @ApiHeaders (name=&#8221;Authorization&#8221;, type=&#8221;string&#8221;, required=true, description=&#8221;\u7528\u6237\u6388\u6743Token&#8221;) *\/ public 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-23256","post","type-post","status-publish","format-standard","hentry","category-16"],"_links":{"self":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/23256","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=23256"}],"version-history":[{"count":0,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/23256\/revisions"}],"wp:attachment":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/media?parent=23256"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/categories?post=23256"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/tags?post=23256"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}