{"id":23619,"date":"2024-11-21T16:07:34","date_gmt":"2024-11-21T08:07:34","guid":{"rendered":"https:\/\/fwq.ai\/blog\/23619\/"},"modified":"2024-11-21T16:07:34","modified_gmt":"2024-11-21T08:07:34","slug":"%e5%a6%82%e4%bd%95%e5%9c%a8thinkphp6%e4%b8%ad%e4%bd%bf%e7%94%a8swagger","status":"publish","type":"post","link":"https:\/\/fwq.ai\/blog\/23619\/","title":{"rendered":"\u5982\u4f55\u5728ThinkPHP6\u4e2d\u4f7f\u7528Swagger"},"content":{"rendered":"

swagger\u662f\u4e00\u79cd\u6d41\u884c\u7684api\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u53ef\u4ee5\u5e2e\u52a9\u5f00\u53d1\u4eba\u5458\u8f7b\u677e\u5730\u521b\u5efa\u3001\u8bbe\u8ba1\u548c\u90e8\u7f72api\u63a5\u53e3\u3002\u5728\u672c\u6587\u4e2d\uff0c\u6211\u4eec\u5c06\u4ecb\u7ecd\u5982\u4f55\u57286\u4e2d\u4f7f\u7528swagger\u6765\u751f\u6210api\u6587\u6863\uff0c\u5e76\u4f7f\u7528swagger-ui\u6765\u67e5\u770b\u548c\u6d4b\u8bd5api\u63a5\u53e3\u3002<\/p>\n

\u7b2c\u4e00\u6b65\uff1a\u5b89\u88c5Swagger-UI\u548cSwagger-Annotations<\/p>\n

\u8981\u5728ThinkPHP6\u4e2d\u4f7f\u7528Swagger\uff0c\u9700\u8981\u5b89\u88c5Swagger-UI\u548cSwagger-Annotations\u4e24\u4e2a\u5e93\u3002\u53ef\u4ee5\u901a\u8fc7Composer\u6765\u5b89\u88c5\u5b83\u4eec\uff0c\u53ea\u9700\u5728\u9879\u76ee\u6839\u76ee\u5f55\u4e0b\u8fd0\u884c\u4ee5\u4e0b\u547d\u4ee4\uff1a<\/p>\n

composer require zircote\/swagger-php\ncomposer require swagger-api\/swagger-ui\n<\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 <\/p>\n
\u7b2c\u4e8c\u6b65\uff1a\u5728\u63a7\u5236\u5668\u4e2d\u6dfb\u52a0Swagger-Annotations<\/p>\n
\u8981\u5728\u63a7\u5236\u5668\u4e2d\u4f7f\u7528Swagger\uff0c\u9700\u8981\u5728\u63a7\u5236\u5668\u7684\u6ce8\u91ca\u4e2d\u6dfb\u52a0Swagger-Annotations\u3002\u4f8b\u5982\uff0c\u4ee5\u4e0b\u662f\u4e00\u4e2a\u793a\u4f8b\u63a7\u5236\u5668\u548c\u5176\u4e2d\u4f7f\u7528Swagger-Annotations\u7684\u793a\u4f8b\u4ee3\u7801\uff1a<\/p>\n
\u7acb\u5373\u5b66\u4e60<\/span>\u201c\u201d\uff1b<\/p>\n
nnotationouteGroup;\nuse thinknnotationouteMiddleware;\nuse thinkController;\n\n\/**\n* @Group(\"\/api\/v1\")\n* @Middleware(class=\"ppmiddlewareToken\")\n*\/\nclass UserController extends Controller\n{\n    \/**\n    * \u7528\u6237\u5217\u8868\u63a5\u53e3\n    *\n    * @SwaggerGet(\n    *     path=\"\/user\/list\",\n    *     summary=\"\u83b7\u53d6\u7528\u6237\u5217\u8868\",\n    *     tags={\"User\"},\n    *     @SwaggerResponse(response=\"200\", description=\"OK\"),\n    *     @SwaggerResponse(response=\"401\", description=\"Unauthorized\"),\n    * )\n    *\/\n    public function index()\n    {\n        \/\/ \u4ee3\u7801\u903b\u8f91\n    }\n}<\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 <\/p>\n
\u5728\u4e0a\u9762\u7684\u4ee3\u7801\u4e2d\uff0c\u6211\u4eec\u4f7f\u7528\u4e86@Group\u6ce8\u91ca\u6765\u6307\u5b9a\u63a7\u5236\u5668\u7684\u8def\u7531\u524d\u7f00\uff0c\u4f7f\u7528@Middleware\u6ce8\u91ca\u6765\u6307\u5b9a\u63a7\u5236\u5668\u4e2d\u95f4\u4ef6\u3002\u800c\u5728index\u65b9\u6cd5\u4e2d\uff0c\u6211\u4eec\u4f7f\u7528\u4e86@SwaggerGet\u6ce8\u91ca\u6765\u6307\u5b9aGET\u8bf7\u6c42\u6240\u9700\u7684\u4fe1\u606f\uff0c\u5982\u8bf7\u6c42\u8def\u5f84\u3001\u63a5\u53e3\u6458\u8981\u3001\u6807\u7b7e\u548c\u54cd\u5e94\u4fe1\u606f\u7b49\u7b49\u3002<\/p>\n
\u7b2c\u4e09\u6b65\uff1a\u751f\u6210Swagger\u6587\u6863<\/p>\n
\u751f\u6210Swagger\u6587\u6863\u7684\u65b9\u6cd5\u6709\u5f88\u591a\u79cd\uff0c\u5305\u62ec\u624b\u52a8\u7f16\u5199Swagger\u6587\u6863\u3001\u4f7f\u7528Swagger\u7f16\u8f91\u5668\u3001\u4f7f\u7528Swagger\u751f\u6210\u5668\u7b49\u7b49\u3002\u5728\u8fd9\u91cc\uff0c\u6211\u4eec\u5c06\u4f7f\u7528Swagger-Annotations\u63d0\u4f9b\u7684\u547d\u4ee4\u884c\u5de5\u5177\u6765\u81ea\u52a8\u751f\u6210Swagger\u6587\u6863\u3002<\/p>\n
\u5728\u9879\u76ee\u6839\u76ee\u5f55\u4e0b\u8f93\u5165\u4ee5\u4e0b\u547d\u4ee4\uff1a<\/p>\n
php think swagger output json &gt; swagger.json\n<\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 <\/p>\n
\u8fd9\u5c06\u4f7f\u7528Swagger-Annotations\u4e2d\u7684output\u547d\u4ee4\u5c06Swagger\u6587\u6863\u8f93\u51fa\u5230JSON\u6587\u4ef6\u4e2d\u3002<\/p>\n
\u7b2c\u56db\u6b65\uff1a\u4f7f\u7528Swagger-UI\u67e5\u770b\u548c\u6d4b\u8bd5API\u63a5\u53e3<\/p>\n
\u73b0\u5728\uff0c\u6211\u4eec\u5df2\u7ecf\u751f\u6210\u4e86Swagger\u6587\u6863\uff0c\u6211\u4eec\u9700\u8981\u5c06\u5b83\u5c55\u793a\u51fa\u6765\u3002\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528Swagger-UI\u6765\u67e5\u770b\u548c\u6d4b\u8bd5API\u63a5\u53e3\u3002<\/p>\n
\u5728\u9879\u76ee\u4e2d\u65b0\u5efa\u4e00\u4e2a\u76ee\u5f55public\/swagger\uff0c\u5c06\u4eceSwagger-UI\u5b98\u7f51\u4e0a\u4e0b\u8f7d\u7684\u6240\u6709\u9759\u6001\u6587\u4ef6\u90fd\u590d\u5236\u5230\u8fd9\u4e2a\u76ee\u5f55\u4e2d\u3002\u7136\u540e\uff0c\u6211\u4eec\u9700\u8981\u4fee\u6539index.html\u6587\u4ef6\u4e2d\u7684url\u53d8\u91cf\uff0c\u5c06\u5176\u6307\u5411\u6211\u4eec\u521a\u624d\u751f\u6210\u7684Swagger\u6587\u6863\u3002<\/p>\n
var url = \"..\/swagger.json\";<\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 <\/p>\n
\u6700\u540e\uff0c\u5728\u6d4f\u89c8\u5668\u4e2d\u6253\u5f00http:\/\/localhost\/swagger\u5373\u53ef\u770b\u5230Swagger-UI\u754c\u9762\u3002\u5728\u8fd9\u91cc\uff0c\u60a8\u53ef\u4ee5\u6d4f\u89c8API\u63a5\u53e3\u6587\u6863\uff0c\u6d4b\u8bd5API\u63a5\u53e3\uff0c\u5e76\u67e5\u770bAPI\u63a5\u53e3\u7684\u8bf7\u6c42\u548c\u54cd\u5e94\u4fe1\u606f\u3002<\/p>\n
\u603b\u7ed3\uff1a<\/p>\n
\u4ee5\u4e0a\u5c31\u662f\u5728ThinkPHP6\u4e2d\u4f7f\u7528Swagger\u751f\u6210API\u6587\u6863\u7684\u5168\u90e8\u6b65\u9aa4\u3002\u901a\u8fc7\u4f7f\u7528Swagger\uff0c\u5f00\u53d1\u4eba\u5458\u53ef\u4ee5\u66f4\u52a0\u65b9\u4fbf\u5730\u5b8c\u6210API\u63a5\u53e3\u7684\u6587\u6863\u7f16\u5199\u3001\u6d4b\u8bd5\u548c\u90e8\u7f72\uff0c\u63d0\u9ad8\u5f00\u53d1\u6548\u7387\uff0c\u964d\u4f4e\u5f00\u53d1\u6210\u672c\u3002\u4f46\u662f\u4e5f\u8981\u6ce8\u610f\u4fdd\u62a4\u597dAPI\u63a5\u53e3\u7684\u5b89\u5168\u6027\uff0c\u9632\u6b62\u6076\u610f\u653b\u51fb\u548c\u6570\u636e\u6cc4\u9732\u3002<\/p>\n
\u4ee5\u4e0a\u5c31\u662f\u5982\u4f55\u5728ThinkPHP6\u4e2d\u4f7f\u7528Swagger\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":"
swagger\u662f\u4e00\u79cd\u6d41\u884c\u7684api\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u53ef\u4ee5\u5e2e\u52a9\u5f00\u53d1\u4eba\u5458\u8f7b\u677e\u5730\u521b\u5efa\u3001\u8bbe\u8ba1\u548c\u90e8\u7f72api\u63a5\u53e3\u3002\u5728\u672c\u6587\u4e2d\uff0c\u6211\u4eec\u5c06\u4ecb\u7ecd\u5982\u4f55\u57286\u4e2d\u4f7f\u7528swagger\u6765\u751f\u6210api\u6587\u6863\uff0c\u5e76\u4f7f\u7528swagger-ui\u6765\u67e5\u770b\u548c\u6d4b\u8bd5api\u63a5\u53e3\u3002 \u7b2c\u4e00\u6b65\uff1a\u5b89\u88c5Swagger-UI\u548cSwagger-Annotations \u8981\u5728ThinkPHP6\u4e2d\u4f7f\u7528Swagger\uff0c\u9700\u8981\u5b89\u88c5Swagger-UI\u548cSwagger-Annotations\u4e24\u4e2a\u5e93\u3002\u53ef\u4ee5\u901a\u8fc7Composer\u6765\u5b89\u88c5\u5b83\u4eec\uff0c\u53ea\u9700\u5728\u9879\u76ee\u6839\u76ee\u5f55\u4e0b\u8fd0\u884c\u4ee5\u4e0b\u547d\u4ee4\uff1a composer require zircote\/swagger-php composer require swagger-api\/swagger-ui \u767b\u5f55\u540e\u590d\u5236 \u7b2c\u4e8c\u6b65\uff1a\u5728\u63a7\u5236\u5668\u4e2d\u6dfb\u52a0Swagger-Annotations \u8981\u5728\u63a7\u5236\u5668\u4e2d\u4f7f\u7528Swagger\uff0c\u9700\u8981\u5728\u63a7\u5236\u5668\u7684\u6ce8\u91ca\u4e2d\u6dfb\u52a0Swagger-Annotations\u3002\u4f8b\u5982\uff0c\u4ee5\u4e0b\u662f\u4e00\u4e2a\u793a\u4f8b\u63a7\u5236\u5668\u548c\u5176\u4e2d\u4f7f\u7528Swagger-Annotations\u7684\u793a\u4f8b\u4ee3\u7801\uff1a \u7acb\u5373\u5b66\u4e60\u201c\u201d\uff1b nnotationouteGroup; use thinknnotationouteMiddleware; use thinkController; \/** * @Group(“\/api\/v1″) * @Middleware(class=”ppmiddlewareToken”) *\/ class UserController extends Controller { \/** * \u7528\u6237\u5217\u8868\u63a5\u53e3 * * @SwaggerGet( * path=”\/user\/list”, * summary=”\u83b7\u53d6\u7528\u6237\u5217\u8868”, * tags={“User”}, * @SwaggerResponse(response=”200″, description=”OK”), * @SwaggerResponse(response=”401″, description=”Unauthorized”), * ) *\/ public function index() { \/\/ […]<\/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-23619","post","type-post","status-publish","format-standard","hentry","category-16"],"_links":{"self":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/23619","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=23619"}],"version-history":[{"count":0,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/23619\/revisions"}],"wp:attachment":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/media?parent=23619"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/categories?post=23619"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/tags?post=23619"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}