{"id":23691,"date":"2024-11-21T10:27:35","date_gmt":"2024-11-21T02:27:35","guid":{"rendered":"https:\/\/fwq.ai\/blog\/23691\/"},"modified":"2024-11-21T10:27:35","modified_gmt":"2024-11-21T02:27:35","slug":"%e5%9c%a8thinkphp6%e4%b8%ad%e4%bd%bf%e7%94%a8openapi","status":"publish","type":"post","link":"https:\/\/fwq.ai\/blog\/23691\/","title":{"rendered":"\u5728ThinkPHP6\u4e2d\u4f7f\u7528OpenAPI"},"content":{"rendered":"<p>\u968f\u7740\u4e92\u8054\u7f51\u6280\u672f\u7684\u53d1\u5c55\uff0capi\uff08application programming interface\uff09\u4f5c\u4e3a\u6570\u636e\u4ea4\u4e92\u7684\u6807\u51c6\u5316\u534f\u8bae\uff0c\u5df2\u7ecf\u6210\u4e3a\u73b0\u4ee3\u8f6f\u4ef6\u5f00\u53d1\u4e0d\u53ef\u6216\u7f3a\u7684\u4e00\u90e8\u5206\u3002\u800copenapi\u4f5c\u4e3a\u4e00\u79cd\u901a\u7528\u7684api\u63cf\u8ff0\u6587\u4ef6\u683c\u5f0f\uff0c\u88ab\u5e7f\u6cdb\u5e94\u7528\u4e8eapi\u7684\u8bbe\u8ba1\u3001\u5f00\u53d1\u4ee5\u53ca\u6587\u6863\u7f16\u5199\u7b49\u5de5\u4f5c\u4e2d\u3002\u5728\u8fd9\u7bc7\u6587\u7ae0\u4e2d\uff0c\u6211\u4eec\u5c06\u4ecb\u7ecd\u5982\u4f55\u57286\u4e2d\u4f7f\u7528openapi\uff0c\u4ee5\u4fbf\u66f4\u597d\u5730\u5b9e\u73b0api\u7684\u5f00\u53d1\u548c\u7ba1\u7406\u3002<\/p>\n<p>\u4e00\u3001OpenAPI\u6982\u8ff0<\/p>\n<p>OpenAPI\u662f\u7531OpenAPI\u89c4\u8303\u59d4\u5458\u4f1a\uff08OpenAPI Initiative\uff09\u6240\u5236\u5b9a\u7684\u4e00\u79cd\u5f00\u653e\u6807\u51c6\u7684API\u63cf\u8ff0\u6587\u4ef6\u683c\u5f0f\u3002\u5b83\u57fa\u4e8eJSON\u6216YAML\u683c\u5f0f\uff0c\u7528\u4e8e\u5b9a\u4e49RESTful API\u7684\u63a5\u53e3\u89c4\u8303\u3001\u683c\u5f0f\u3001\u53c2\u6570\u3001\u54cd\u5e94\u4ee5\u53ca\u5b89\u5168\u7b49\u4fe1\u606f\u3002OpenAPI\u7684\u76ee\u7684\u662f\u4e3a\u4e86\u4f7fAPI\u7684\u5f00\u53d1\u3001\u53d1\u5e03\u548c\u6587\u6863\u7f16\u5199\u7b49\u8fc7\u7a0b\u66f4\u52a0\u89c4\u8303\u5316\uff0c\u5e76\u4fdd\u8bc1API\u7684\u53ef\u91cd\u7528\u6027\u548c\u4e92\u64cd\u4f5c\u6027\u3002<\/p>\n<p>\u4e8c\u3001\u5b89\u88c5OpenAPI\u6269\u5c55\u5e93<\/p>\n<p>\u5728ThinkPHP6\u4e2d\u4f7f\u7528OpenAPI\uff0c\u9700\u8981\u5148\u5b89\u88c5\u5bf9\u5e94\u7684\u6269\u5c55\u5e93\uff0c\u53ef\u4ee5\u901a\u8fc7Composer\u8fdb\u884c\u5b89\u88c5\u3002\u6253\u5f00\u547d\u4ee4\u884c\u5de5\u5177\uff0c\u5207\u6362\u5230\u4f60\u7684ThinkPHP6\u9879\u76ee\u6839\u76ee\u5f55\u4e0b\uff0c\u8f93\u5165\u4ee5\u4e0b\u547d\u4ee4\uff1a<\/p>\n<p><span>\u7acb\u5373\u5b66\u4e60<\/span>\u201c\u201d\uff1b<\/p>\n<pre>composer require zircote\/swagger-php<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<p>\u5b89\u88c5\u5b8c\u6bd5\u540e\uff0c\u4f1a\u5728vendor\u76ee\u5f55\u4e0b\u751f\u6210swagger-php\u6587\u4ef6\u5939\uff0c\u8868\u793aOpenAPI\u6269\u5c55\u5e93\u5df2\u7ecf\u5b89\u88c5\u6210\u529f\u3002<\/p>\n<p>\u4e09\u3001\u521b\u5efaOpenAPI\u6587\u6863<\/p>\n<p>\u5728ThinkPHP6\u4e2d\uff0c\u53ef\u4ee5\u901a\u8fc7\u6ce8\u91ca\u65b9\u5f0f\u6765\u521b\u5efaOpenAPI\u6587\u6863\u3002\u5728\u9700\u8981\u521b\u5efaOpenAPI\u6587\u6863\u7684\u65b9\u6cd5\u4e2d\u6dfb\u52a0\u5982\u4e0b\u6ce8\u91ca\uff1a<\/p>\n<pre>\/**\n * @OAGet(\n *   path=\"\/api\/users\/{id}\",\n *   summary=\"\u83b7\u53d6\u7528\u6237\u4fe1\u606f\",\n *   tags={\"Users\"},\n *   @OAParameter(\n *     name=\"id\",\n *     in=\"path\",\n *     description=\"\u7528\u6237ID\",\n *     required=true,\n *     @OASchema(\n *          type=\"integer\"\n *     )\n *   ),\n *   @OAResponse(\n *     response=200,\n *     description=\"\u83b7\u53d6\u6210\u529f\",\n *     @OAJsonContent(\n *        @OAProperty(property=\"id\", type=\"integer\", description=\"\u7528\u6237ID\"),\n *        @OAProperty(property=\"name\", type=\"string\", description=\"\u7528\u6237\u59d3\u540d\"),\n *        @OAProperty(property=\"age\", type=\"integer\", description=\"\u7528\u6237\u5e74\u9f84\")\n *     )\n * ),\n * @OAResponse(\n *     response=404,\n *     description=\"\u672a\u627e\u5230\u8be5\u7528\u6237\",\n *     @OAJsonContent(\n *        @OAProperty(property=\"message\", type=\"string\", description=\"\u9519\u8bef\u4fe1\u606f\")\n *     )\n *   )\n * )\n *\/<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<p>\u5176\u4e2d\uff0c@OAGet\u8868\u793a\u8fd9\u662f\u4e00\u4e2aHTTP GET\u8bf7\u6c42\uff0cpath\u5c5e\u6027\u8868\u793aAPI\u7684\u8bf7\u6c42\u8def\u5f84\uff1bsummary\u5c5e\u6027\u4e3aAPI\u7684\u6458\u8981\u4fe1\u606f\uff1btags\u5c5e\u6027\u8868\u793aAPI\u7684\u6807\u7b7e\uff1b@OAParameter\u8868\u793aAPI\u7684\u53c2\u6570\u4fe1\u606f\uff1b@OASchema\u8868\u793a\u53c2\u6570\u7684\u7c7b\u578b\u7b49\u4fe1\u606f\uff1b@OAResponse\u8868\u793aAPI\u7684\u54cd\u5e94\u4fe1\u606f\uff1b@OAJsonContent\u8868\u793a\u54cd\u5e94\u5185\u5bb9\u4e3aJSON\u683c\u5f0f\u3002\u66f4\u591a\u53ef\u7528\u6ce8\u91ca\u8bf7\u53c2\u8003\u5b98\u65b9\u6587\u6863\u3002<\/p>\n<p>\u56db\u3001\u751f\u6210OpenAPI\u6587\u6863<\/p>\n<p>\u5f53\u6211\u4eec\u6dfb\u52a0\u597d\u6ce8\u91ca\u540e\uff0c\u53ef\u4ee5\u901a\u8fc7\u6267\u884c\u4ee5\u4e0b\u547d\u4ee4\u5373\u53ef\u751f\u6210OpenAPI\u6587\u6863\uff1a<\/p>\n<pre>php think swagger:export --output=.\/public\/swagger.json<\/pre>\n<p> \u767b\u5f55\u540e\u590d\u5236 <\/p>\n<p>\u5176\u4e2d\uff0c&#8211;output\u6307\u5b9a\u8f93\u51fa\u6587\u4ef6\u8def\u5f84\u3002<\/p>\n<p>\u4e94\u3001\u4f7f\u7528OpenAPI\u6587\u6863<\/p>\n<p>\u751f\u6210OpenAPI\u6587\u6863\u540e\uff0c\u6211\u4eec\u53ef\u4ee5\u901a\u8fc7Swagger UI\u5de5\u5177\u6765\u67e5\u770b\u548c\u4f7f\u7528OpenAPI\u3002\u5c06Swagger UI\u6e90\u4ee3\u7801\u4e0b\u8f7d\u4e0b\u6765\u5e76\u89e3\u538b\u7f29\u5230\u4f60\u7684Web\u670d\u52a1\u5668\u76ee\u5f55\u4e2d\uff0c\u7136\u540e\u8bbf\u95eeindex.html\u6587\u4ef6\u5373\u53ef\u770b\u5230Swagger UI\u754c\u9762\u3002\u5728\u754c\u9762\u7684\u8bf7\u6c42\u5730\u5740\u8f93\u5165\u6846\u4e2d\uff0c\u8f93\u5165\u751f\u6210\u7684OpenAPI\u6587\u6863\u5730\u5740\u5373\u53ef\u67e5\u770b\u548c\u6d4b\u8bd5API\u63a5\u53e3\u3002<\/p>\n<p>\u516d\u3001\u603b\u7ed3<\/p>\n<p>\u5f00\u53d1\u4e00\u4e2a\u5b8c\u6574\u7684API\u53ef\u4ee5\u662f\u4e00\u9879\u590d\u6742\u7684\u4efb\u52a1\uff0c\u4f7f\u7528OpenAPI\u53ef\u4ee5\u5f88\u597d\u5730\u5e2e\u52a9\u6211\u4eec\u89c4\u8303\u548c\u7ba1\u7406API\u7684\u5f00\u53d1\u548c\u6587\u6863\u7f16\u5199\uff0c\u5e76\u63d0\u9ad8API\u7684\u53ef\u91cd\u7528\u6027\u548c\u4e92\u64cd\u4f5c\u6027\u3002\u5728ThinkPHP6\u4e2d\u4f7f\u7528OpenAPI\u4e5f\u662f\u4e00\u4ef6\u975e\u5e38\u65b9\u4fbf\u7684\u4e8b\u60c5\uff0c\u53ea\u9700\u8981\u5b89\u88c5OpenAPI\u6269\u5c55\u5e93\u5e76\u6dfb\u52a0\u6ce8\u91ca\u5c31\u53ef\u4ee5\u8f7b\u677e\u521b\u5efaAPI\u6587\u6863\u3002\u56e0\u6b64\uff0c\u5f00\u53d1\u4eba\u5458\u53ef\u4ee5\u66f4\u52a0\u4e13\u6ce8\u4e8eAPI\u7684\u8bbe\u8ba1\u548c\u5b9e\u73b0\uff0c\u63d0\u9ad8\u5f00\u53d1\u6548\u7387\u548c\u4ee3\u7801\u8d28\u91cf\u3002<\/p>\n<p>\u4ee5\u4e0a\u5c31\u662f\u5728ThinkPHP6\u4e2d\u4f7f\u7528OpenAPI\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\u6280\u672f\u7684\u53d1\u5c55\uff0capi\uff08application programming interface\uff09\u4f5c\u4e3a\u6570\u636e\u4ea4\u4e92\u7684\u6807\u51c6\u5316\u534f\u8bae\uff0c\u5df2\u7ecf\u6210\u4e3a\u73b0\u4ee3\u8f6f\u4ef6\u5f00\u53d1\u4e0d\u53ef\u6216\u7f3a\u7684\u4e00\u90e8\u5206\u3002\u800copenapi\u4f5c\u4e3a\u4e00\u79cd\u901a\u7528\u7684api\u63cf\u8ff0\u6587\u4ef6\u683c\u5f0f\uff0c\u88ab\u5e7f\u6cdb\u5e94\u7528\u4e8eapi\u7684\u8bbe\u8ba1\u3001\u5f00\u53d1\u4ee5\u53ca\u6587\u6863\u7f16\u5199\u7b49\u5de5\u4f5c\u4e2d\u3002\u5728\u8fd9\u7bc7\u6587\u7ae0\u4e2d\uff0c\u6211\u4eec\u5c06\u4ecb\u7ecd\u5982\u4f55\u57286\u4e2d\u4f7f\u7528openapi\uff0c\u4ee5\u4fbf\u66f4\u597d\u5730\u5b9e\u73b0api\u7684\u5f00\u53d1\u548c\u7ba1\u7406\u3002 \u4e00\u3001OpenAPI\u6982\u8ff0 OpenAPI\u662f\u7531OpenAPI\u89c4\u8303\u59d4\u5458\u4f1a\uff08OpenAPI Initiative\uff09\u6240\u5236\u5b9a\u7684\u4e00\u79cd\u5f00\u653e\u6807\u51c6\u7684API\u63cf\u8ff0\u6587\u4ef6\u683c\u5f0f\u3002\u5b83\u57fa\u4e8eJSON\u6216YAML\u683c\u5f0f\uff0c\u7528\u4e8e\u5b9a\u4e49RESTful API\u7684\u63a5\u53e3\u89c4\u8303\u3001\u683c\u5f0f\u3001\u53c2\u6570\u3001\u54cd\u5e94\u4ee5\u53ca\u5b89\u5168\u7b49\u4fe1\u606f\u3002OpenAPI\u7684\u76ee\u7684\u662f\u4e3a\u4e86\u4f7fAPI\u7684\u5f00\u53d1\u3001\u53d1\u5e03\u548c\u6587\u6863\u7f16\u5199\u7b49\u8fc7\u7a0b\u66f4\u52a0\u89c4\u8303\u5316\uff0c\u5e76\u4fdd\u8bc1API\u7684\u53ef\u91cd\u7528\u6027\u548c\u4e92\u64cd\u4f5c\u6027\u3002 \u4e8c\u3001\u5b89\u88c5OpenAPI\u6269\u5c55\u5e93 \u5728ThinkPHP6\u4e2d\u4f7f\u7528OpenAPI\uff0c\u9700\u8981\u5148\u5b89\u88c5\u5bf9\u5e94\u7684\u6269\u5c55\u5e93\uff0c\u53ef\u4ee5\u901a\u8fc7Composer\u8fdb\u884c\u5b89\u88c5\u3002\u6253\u5f00\u547d\u4ee4\u884c\u5de5\u5177\uff0c\u5207\u6362\u5230\u4f60\u7684ThinkPHP6\u9879\u76ee\u6839\u76ee\u5f55\u4e0b\uff0c\u8f93\u5165\u4ee5\u4e0b\u547d\u4ee4\uff1a \u7acb\u5373\u5b66\u4e60\u201c\u201d\uff1b composer require zircote\/swagger-php \u767b\u5f55\u540e\u590d\u5236 \u5b89\u88c5\u5b8c\u6bd5\u540e\uff0c\u4f1a\u5728vendor\u76ee\u5f55\u4e0b\u751f\u6210swagger-php\u6587\u4ef6\u5939\uff0c\u8868\u793aOpenAPI\u6269\u5c55\u5e93\u5df2\u7ecf\u5b89\u88c5\u6210\u529f\u3002 \u4e09\u3001\u521b\u5efaOpenAPI\u6587\u6863 \u5728ThinkPHP6\u4e2d\uff0c\u53ef\u4ee5\u901a\u8fc7\u6ce8\u91ca\u65b9\u5f0f\u6765\u521b\u5efaOpenAPI\u6587\u6863\u3002\u5728\u9700\u8981\u521b\u5efaOpenAPI\u6587\u6863\u7684\u65b9\u6cd5\u4e2d\u6dfb\u52a0\u5982\u4e0b\u6ce8\u91ca\uff1a \/** * @OAGet( * path=&#8221;\/api\/users\/{id}&#8221;, * summary=&#8221;\u83b7\u53d6\u7528\u6237\u4fe1\u606f&#8221;, * tags={&#8220;Users&#8221;}, * @OAParameter( * name=&#8221;id&#8221;, * in=&#8221;path&#8221;, * description=&#8221;\u7528\u6237ID&#8221;, * required=true, * @OASchema( * type=&#8221;integer&#8221; * ) * ), * @OAResponse( * response=200, * description=&#8221;\u83b7\u53d6\u6210\u529f&#8221;, * @OAJsonContent( * @OAProperty(property=&#8221;id&#8221;, type=&#8221;integer&#8221;, [&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-23691","post","type-post","status-publish","format-standard","hentry","category-16"],"_links":{"self":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/23691","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=23691"}],"version-history":[{"count":0,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/23691\/revisions"}],"wp:attachment":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/media?parent=23691"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/categories?post=23691"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/tags?post=23691"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}