{"id":85458,"date":"2024-04-01T17:55:47","date_gmt":"2024-04-01T09:55:47","guid":{"rendered":"https:\/\/docs.pingcode.com\/?p=85458"},"modified":"2024-04-01T17:55:47","modified_gmt":"2024-04-01T09:55:47","slug":"swagger%e7%a9%b6%e7%ab%9f%e6%98%af%e4%b8%aa%e4%bb%80%e4%b9%88%e6%a0%b7%e7%9a%84%e5%b7%a5%e5%85%b7","status":"publish","type":"post","link":"https:\/\/docs.pingcode.com\/ask\/85458.html","title":{"rendered":"swagger\u7a76\u7adf\u662f\u4e2a\u4ec0\u4e48\u6837\u7684\u5de5\u5177"},"content":{"rendered":"<p style=\"text-align:center;\" ><img decoding=\"async\" src=\"https:\/\/cdn-docs.pingcode.com\/wp-content\/uploads\/2024\/04\/uploading_images34-project-management-software-interface-boasting-a-user-friendly-digital-render-task-schedules-notif.png?x-oss-process=image\/auto-orient,1\/format,webp\" alt=\"swagger\u7a76\u7adf\u662f\u4e2a\u4ec0\u4e48\u6837\u7684\u5de5\u5177\" \/><\/p>\n<p><strong>Swagger\u662f\u4e00\u4e2a\u5f00\u6e90\u7684API\u5f00\u53d1\u5de5\u5177<\/strong>\uff0c\u5b83\u9075\u5faaOpenAPI\u89c4\u8303\u3001<strong>\u5e2e\u52a9\u5f00\u53d1\u8005\u8bbe\u8ba1\u3001\u6784\u5efa\u3001\u8bb0\u5f55\u4ee5\u53ca\u4f7f\u7528RESTful Web\u670d\u52a1<\/strong>\u3002Swagger\u5177\u5907\u7528\u6237\u754c\u9762\u53cb\u597d\u3001\u652f\u6301API\u7684\u6574\u4e2a\u751f\u547d\u5468\u671f\u3001\u80fd\u591f\u5e2e\u52a9\u751f\u6210\u5ba2\u6237\u7aefSDK\u7b49\u7279\u70b9\u3002\u5176\u4e2d\u4e00\u4e2a\u4e3b\u8981\u529f\u80fd\u662f<strong>\u81ea\u52a8\u751f\u6210\u5728\u7ebf\u53ef\u4ea4\u4e92\u7684API\u6587\u6863<\/strong>\uff0c\u51cf\u5c11\u4e86\u624b\u52a8\u7f16\u5199API\u6587\u6863\u7684\u5de5\u4f5c\u91cf\uff0c\u540c\u65f6\u63d0\u9ad8\u4e86API\u6587\u6863\u7684\u51c6\u786e\u6027\u548c\u53ef\u7528\u6027\u3002<\/p>\n<h2><strong>\u4e00\u3001API\u8bbe\u8ba1\u4e0e\u6a21\u62df<\/strong><\/h2>\n<p>Swagger\u5141\u8bb8\u5f00\u53d1\u8005\u5728\u7f16\u7801\u4e4b\u524d\u8bbe\u8ba1API\u3002\u901a\u8fc7\u7f16\u5199Swagger\u89c4\u8303\u6587\u4ef6\uff0c\u5f00\u53d1\u8005\u53ef\u4ee5\u5b9a\u4e49API\u7684\u7ed3\u6784\uff0c\u5305\u62ec\u7aef\u70b9\u3001\u53c2\u6570\u3001\u54cd\u5e94\u7b49\u3002Swagger Editor\u63d0\u4f9b\u4e86\u4e00\u4e2a\u53ef\u89c6\u5316\u754c\u9762\uff0c\u4f7f\u5f97\u8bbe\u8ba1\u63a5\u53e3\u53d8\u5f97\u76f4\u89c2\u548c\u9ad8\u6548\u3002\u5b9a\u4e49\u5b8c\u6210\u540e\uff0cSwagger UI\u53ef\u4ee5\u5c06\u8fd9\u4e9b\u89c4\u8303\u53ef\u89c6\u5316\u4e3a\u4e00\u4e2a\u4ea4\u4e92\u5f0f\u7684API\u6587\u6863\uff0c\u5176\u4ed6\u5f00\u53d1\u8005\u53ef\u4ee5\u901a\u8fc7\u5b83\u4e86\u89e3API\u7684\u529f\u80fd\uff0c\u5e76\u8fdb\u884c\u6d4b\u8bd5\u3002Swager Codegen\u53ef\u4ee5\u6839\u636e\u89c4\u8303\u81ea\u52a8\u751f\u6210\u670d\u52a1\u5668\u7aef\u4ee3\u7801\u6869\u548c\u5ba2\u6237\u7aefSDK\uff0c\u6781\u5927\u5730\u52a0\u5feb\u4e86\u5f00\u53d1\u8fdb\u7a0b\u3002<\/p>\n<h2><strong>\u4e8c\u3001API\u6587\u6863\u81ea\u52a8\u751f\u6210<\/strong><\/h2>\n<p>Swagger\u6700\u88ab\u5e7f\u6cdb\u8a89\u4e3a\u5f3a\u5927\u7684\u529f\u80fd\u662f\u81ea\u52a8\u751f\u6210API\u6587\u6863\u7684\u80fd\u529b\u3002<strong>\u6587\u6863\u540c\u6b65\u66f4\u65b0<\/strong>\uff0c\u968f\u7740\u540e\u7aef\u4ee3\u7801\u7684\u6539\u53d8\u800c\u5b9e\u65f6\u66f4\u65b0\uff0c\u4fdd\u6301\u6587\u6863\u4e0eAPI\u5b9e\u9645\u884c\u4e3a\u7684\u4e00\u81f4\u6027\u3002Swagger UI\u63d0\u4f9b\u4e86\u4e00\u4e2a\u6e05\u6d01\u4e14\u53ef\u4ea4\u4e92\u7684\u754c\u9762\uff0cAPI\u6d88\u8d39\u8005\u53ef\u4ee5\u4e0d\u9700\u8981\u4efb\u4f55\u5de5\u5177\u5c31\u80fd\u76f4\u63a5\u5728\u6587\u6863\u9875\u9762\u4e0a\u6d4b\u8bd5API\uff0c\u6781\u5927\u5730\u63d0\u9ad8\u4e86API\u7684\u53ef\u8bbf\u95ee\u6027\u548c\u5f00\u53d1\u8005\u7684\u4f53\u9a8c\u3002<\/p>\n<h2><strong>\u4e09\u3001API\u6d4b\u8bd5<\/strong><\/h2>\n<p>Swagger\u4e0d\u4ec5\u4ec5\u662f\u4e00\u4e2a\u6587\u6863\u5de5\u5177\uff0c\u5b83\u8fd8\u63d0\u4f9b\u4e86\u4e00\u4e9b\u4fbf\u6377\u7684\u65b9\u5f0f\u5bf9API\u8fdb\u884c\u6d4b\u8bd5\u3002Swagger UI\u6216Swagger Editor\u5141\u8bb8\u76f4\u63a5\u53d1\u9001HTTP\u8bf7\u6c42\u5230\u6307\u5b9a\u7684API\uff0c\u67e5\u770b\u5b9e\u65f6\u7684\u54cd\u5e94\u3002\u800cSwagger Inspector\u5219\u63d0\u4f9b\u4e86\u66f4\u52a0\u5f3a\u5927\u7684\u6d4b\u8bd5\u529f\u80fd\uff0c\u5141\u8bb8\u521b\u5efa\u590d\u6742\u7684API\u6d4b\u8bd5\u7528\u4f8b\uff0c\u5e76\u652f\u6301\u5c06\u8fd9\u4e9b\u7528\u4f8b\u5bfc\u51fa\u5230Swagger Hub\u3002<\/p>\n<h2><strong>\u56db\u3001\u8de8\u8bed\u8a00\u5e73\u53f0\u652f\u6301<\/strong><\/h2>\n<p><strong>Swagger Codegen\u652f\u6301\u591a\u79cd\u8bed\u8a00\u548c\u5e73\u53f0<\/strong>\uff0c\u53ef\u4ee5\u6839\u636eSwagger\u89c4\u683c\u6587\u4ef6\u81ea\u52a8\u4e3a\u51e0\u4e4e\u4efb\u4f55\u8bed\u8a00\u6216\u5e73\u53f0\u751f\u6210API\u5ba2\u6237\u7aef\u5e93\u3001\u670d\u52a1\u5668\u6869\u548c\u6587\u6863\u3002\u8fd9\u610f\u5473\u7740\u65e0\u8bba\u5f00\u53d1\u56e2\u961f\u91c7\u7528\u4ec0\u4e48\u8bed\u8a00\u6216\u6846\u67b6\uff0cSwagger\u90fd\u80fd\u63d0\u4f9b\u652f\u6301\uff0c\u786e\u4fddAPI\u53ef\u4ee5\u88ab\u5e7f\u6cdb\u4f7f\u7528\u548c\u6574\u5408\u3002<\/p>\n<h2><strong>\u4e94\u3001\u793e\u533a\u4e0e\u751f\u6001\u7cfb\u7edf<\/strong><\/h2>\n<p><strong>Swagger\u5177\u6709\u4e00\u4e2a\u5f3a\u5927\u7684\u793e\u533a<\/strong>\uff0c\u8bb8\u591a\u5f00\u53d1\u8005\u548c\u516c\u53f8\u90fd\u5728\u4f7f\u7528\u548c\u8d21\u732e\u5b83\u3002OpenAPI\u89c4\u8303\uff08\u539f\u5148\u79f0\u4e4b\u4e3aSwagger\u89c4\u8303\uff09\u5df2\u7ecf\u6210\u4e3a\u4e86\u4e1a\u754c\u7684\u6807\u51c6\uff0c\u5f88\u591a\u5176\u4ed6\u5de5\u5177\u5982Postman\u3001Apiary\u4e5f\u652f\u6301\u5b83\u3002Swagger Hub\u662f\u4e00\u4e2a\u4e91\u670d\u52a1\uff0c\u63d0\u4f9b\u4e86\u66f4\u8fdb\u4e00\u6b65\u7684\u56e2\u961f\u5408\u4f5c\u3001API\u8bbe\u8ba1\u548c\u6587\u6863\u7ba1\u7406\u529f\u80fd\u3002\u8fd9\u4e2a\u5f3a\u5927\u7684\u751f\u6001\u7cfb\u7edf\u4fdd\u8bc1\u4e86Swagger\u5de5\u5177\u7684\u6301\u7eed\u8fdb\u6b65\u548c\u6269\u5c55\u3002<\/p>\n<p>Swagger\u662f\u4e00\u4e2a\u975e\u5e38\u5b9e\u7528\u7684\u5de5\u5177\u96c6\uff0c\u5b83\u8ba9API\u7684\u8bbe\u8ba1\u3001\u5f00\u53d1\u3001\u6d4b\u8bd5\u4e0e\u6587\u6863\u5316\u5de5\u4f5c\u53d8\u5f97\u9ad8\u6548\u5e76\u4e14\u6807\u51c6\u5316\u3002\u4f7f\u7528Swagger\uff0c\u53ef\u4ee5\u63d0\u5347API\u5f00\u53d1\u6d41\u7a0b\u7684\u900f\u660e\u5ea6\u548c\u534f\u4f5c\u6548\u7387\uff0c\u540c\u65f6\u4e5f\u53ef\u4ee5\u63d0\u4f9b\u66f4\u7a33\u5b9a\u53ef\u9760\u7684API\u670d\u52a1\u3002<\/p>\n<h2><strong>\u76f8\u5173\u95ee\u7b54FAQs\uff1a<\/strong><\/h2>\n<p><strong>1. Swagger\u662f\u4ec0\u4e48\uff1f\u5b83\u6709\u54ea\u4e9b\u4e3b\u8981\u529f\u80fd\u548c\u7528\u9014\uff1f<\/strong><br \/>\nSwagger\u662f\u4e00\u6b3e\u7528\u4e8e\u8bbe\u8ba1\u3001\u6784\u5efa\u548c\u6587\u6863\u5316RESTful API\u7684\u5f00\u6e90\u5de5\u5177\u3002\u5b83\u63d0\u4f9b\u4e86\u4e00\u5957\u7b80\u5355\u800c\u5f3a\u5927\u7684\u5de5\u5177\uff0c\u80fd\u591f\u5e2e\u52a9\u5f00\u53d1\u4eba\u5458\u5728\u4e0d\u540c\u7684\u7f16\u7a0b\u8bed\u8a00\u4e2d\u5b9a\u4e49\u3001\u6784\u5efa\u548c\u8c03\u8bd5API\u3002\u5229\u7528Swagger\uff0c\u5f00\u53d1\u4eba\u5458\u53ef\u4ee5\u8f7b\u677e\u5730\u521b\u5efa\u53ef\u8bfb\u6027\u5f3a\u3001\u6613\u4e8e\u7406\u89e3\u7684API\u6587\u6863\uff0c\u5e76\u6839\u636e\u8fd9\u4e9b\u6587\u6863\u751f\u6210\u4ea4\u4e92\u5f0fAPI\u8c03\u8bd5\u754c\u9762\u3002\u5b83\u8fd8\u80fd\u591f\u751f\u6210\u5ba2\u6237\u7aefSDK\u548c\u670d\u52a1\u5668\u5b58\u6839\u4ee3\u7801\uff0c\u52a0\u5feb\u4e86API\u5f00\u53d1\u7684\u901f\u5ea6\u548c\u8d28\u91cf\u3002<\/p>\n<p><strong>2. \u5982\u4f55\u4f7f\u7528Swagger\u6765\u5b9a\u4e49\u548c\u8bbe\u8ba1API\uff1f<\/strong><br \/>\n\u4f7f\u7528Swagger\uff0c\u60a8\u53ef\u4ee5\u901a\u8fc7\u7f16\u5199YAML\u6216JSON\u683c\u5f0f\u7684Swagger\u89c4\u8303\u6587\u4ef6\u6765\u5b9a\u4e49\u548c\u8bbe\u8ba1API\u3002\u5728\u8fd9\u4e2a\u89c4\u8303\u6587\u4ef6\u4e2d\uff0c\u60a8\u53ef\u4ee5\u6307\u5b9aAPI\u7684\u8def\u5f84\u3001\u8bf7\u6c42\u53c2\u6570\u3001\u54cd\u5e94\u8fd4\u56de\u7c7b\u578b\u3001\u8ba4\u8bc1\u673a\u5236\u7b49\u7b49\u3002\u901a\u8fc7\u4f7f\u7528Swagger\u7684\u6ce8\u89e3\uff0c\u60a8\u8fd8\u53ef\u4ee5\u7ed9API\u6dfb\u52a0\u63cf\u8ff0\u3001\u6807\u7b7e\u3001\u793a\u4f8b\u548c\u5176\u4ed6\u5143\u6570\u636e\uff0c\u4ece\u800c\u8fdb\u4e00\u6b65\u4e30\u5bccAPI\u6587\u6863\u7684\u5185\u5bb9\u3002\u60a8\u53ef\u4ee5\u4f7f\u7528Swagger\u7f16\u8f91\u5668\u6216\u96c6\u6210\u7684\u63d2\u4ef6\u6765\u5b9e\u65f6\u7f16\u8f91\u548c\u67e5\u770bAPI\u5b9a\u4e49\uff0c\u786e\u4fddAPI\u7684\u4e00\u81f4\u6027\u548c\u51c6\u786e\u6027\u3002<\/p>\n<p><strong>3. \u5982\u4f55\u4f7f\u7528Swagger\u6765\u751f\u6210API\u6587\u6863\u548c\u63a5\u53e3\u8c03\u8bd5\u754c\u9762\uff1f<\/strong><br \/>\n\u4f7f\u7528Swagger\uff0c\u60a8\u53ef\u4ee5\u8f7b\u677e\u5730\u6839\u636eAPI\u5b9a\u4e49\u6587\u4ef6\u81ea\u52a8\u751f\u6210\u7f8e\u89c2\u6613\u8bfb\u7684API\u6587\u6863\u3002\u901a\u8fc7\u4f7f\u7528Swagger UI\uff0c\u60a8\u53ef\u4ee5\u5c06Swagger\u89c4\u8303\u6587\u4ef6\u76f4\u63a5\u6e32\u67d3\u4e3a\u4e00\u4e2a\u4ea4\u4e92\u5f0f\u7684API\u6587\u6863\u7f51\u9875\uff0c\u5176\u4e2d\u5305\u542b\u4e86API\u7684\u8be6\u7ec6\u8bf4\u660e\u3001\u53c2\u6570\u4fe1\u606f\u3001\u793a\u4f8b\u8bf7\u6c42\u548c\u54cd\u5e94\u4ee5\u53ca\u5176\u4ed6\u76f8\u5173\u4fe1\u606f\u3002\u8fd9\u4f7f\u5f97\u5f00\u53d1\u4eba\u5458\u548c\u7ec8\u7aef\u7528\u6237\u53ef\u4ee5\u5feb\u901f\u4e86\u89e3\u548c\u6d4b\u8bd5API\u7684\u529f\u80fd\u548c\u7528\u6cd5\u3002\u540c\u65f6\uff0c\u60a8\u8fd8\u53ef\u4ee5\u6839\u636eAPI\u5b9a\u4e49\u6587\u4ef6\u751f\u6210\u5ba2\u6237\u7aefSDK\u548c\u670d\u52a1\u5668\u5b58\u6839\u4ee3\u7801\uff0c\u8fd9\u6837\u53ef\u4ee5\u52a0\u5febAPI\u7684\u5f00\u53d1\u548c\u96c6\u6210\u8fc7\u7a0b\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"Swagger\u662f\u4e00\u4e2a\u5f00\u6e90\u7684API\u5f00\u53d1\u5de5\u5177\uff0c\u5b83\u9075\u5faaOpenAPI\u89c4\u8303\u3001\u5e2e\u52a9\u5f00\u53d1\u8005\u8bbe\u8ba1\u3001\u6784\u5efa\u3001\u8bb0\u5f55\u4ee5\u53ca\u4f7f\u7528REST [&hellip;]","protected":false},"author":1,"featured_media":85459,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[37],"tags":[215],"acf":[],"_links":{"self":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/85458"}],"collection":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/comments?post=85458"}],"version-history":[{"count":0,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/85458\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media\/85459"}],"wp:attachment":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media?parent=85458"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/categories?post=85458"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/tags?post=85458"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}