{"id":116257,"date":"2024-04-19T13:56:28","date_gmt":"2024-04-19T05:56:28","guid":{"rendered":"https:\/\/docs.pingcode.com\/ask\/ask-ask\/116257.html"},"modified":"2024-04-19T13:56:30","modified_gmt":"2024-04-19T05:56:30","slug":"%e5%a6%82%e4%bd%95%e7%a1%ae%e4%bf%9dapi%e7%9a%84%e4%bb%a3%e7%a0%81%e8%b4%a8%e9%87%8f","status":"publish","type":"post","link":"https:\/\/docs.pingcode.com\/ask\/ask-ask\/116257.html","title":{"rendered":"\u5982\u4f55\u786e\u4fddAPI\u7684\u4ee3\u7801\u8d28\u91cf"},"content":{"rendered":"<p style=\"text-align:center\"><img decoding=\"async\" src=\"https:\/\/cdn-kb.worktile.com\/kb\/wp-content\/uploads\/2024\/04\/02172321\/73e1f205-d956-4c0b-8a9c-bd0cd1ba8e16.webp\" alt=\"\u5982\u4f55\u786e\u4fddAPI\u7684\u4ee3\u7801\u8d28\u91cf\" \/><\/p>\n<p><p><strong>\u786e\u4fddAPI\u7684\u4ee3\u7801\u8d28\u91cf<\/strong>\u7684\u5173\u952e\u6b65\u9aa4\u5305\u62ec<strong>\u7f16\u5199\u6e05\u6670\u7684API\u89c4\u8303\u3001\u5b9e\u65bd<a href=\"https:\/\/docs.pingcode.com\/code-review\" target=\"_blank\">\u4ee3\u7801\u5ba1\u67e5<\/a>\u3001\u8fd0\u7528\u81ea\u52a8\u5316\u6d4b\u8bd5\u3001\u8fdb\u884c\u6301\u7eed\u96c6\u6210\u3001\u7ef4\u62a4\u826f\u597d\u7684\u6587\u6863<\/strong>\uff0c\u4ee5\u53ca<strong>\u76d1\u63a7API\u6027\u80fd<\/strong>\u3002\u5728\u8fd9\u4e9b\u5173\u952e\u6b65\u9aa4\u4e2d\uff0c\u5c24\u5176\u91cd\u8981\u7684\u662f<strong>\u81ea\u52a8\u5316\u6d4b\u8bd5<\/strong>\uff0c\u5b83\u53ef\u4ee5\u6709\u6548\u5730\u68c0\u67e5API\u5728\u4e0d\u540c\u60c5\u51b5\u4e0b\u7684\u8868\u73b0\uff0c\u9a8c\u8bc1\u529f\u80fd\u7684\u6b63\u786e\u6027\u5e76\u786e\u4fdd\u5728\u66f4\u65b0\u4ee3\u7801\u6216\u6dfb\u52a0\u65b0\u7279\u6027\u65f6\u4e0d\u4f1a\u5bfc\u81f4\u5df2\u6709\u529f\u80fd\u51fa\u73b0\u95ee\u9898\u3002<\/p>\n<\/p>\n<p><p>\u81ea\u52a8\u5316\u6d4b\u8bd5\u901a\u8fc7\u51cf\u5c11\u4eba\u5de5\u5e72\u9884\u6765\u964d\u4f4e\u9519\u8bef\u7387\uff0c\u5e76\u53ef\u786e\u4fdd\u5f00\u53d1\u56e2\u961f\u80fd\u591f\u5feb\u901f\u54cd\u5e94\u95ee\u9898\u3002\u6b64\u5916\uff0c\u81ea\u52a8\u5316\u6d4b\u8bd5\u53ef\u4ee5\u65e0\u6b67\u89c6\u5730\u5bf9API\u8fdb\u884c\u5168\u9762\u6d4b\u8bd5\uff0c\u4e0d\u8bba\u662f\u529f\u80fd\u6027\u6d4b\u8bd5\u3001\u8d1f\u8f7d\u6d4b\u8bd5\u8fd8\u662f\u5b89\u5168\u6027\u6d4b\u8bd5\u7b49\uff0c\u5b83\u90fd\u662f\u4fdd\u8bc1API\u8d28\u91cf\u4e0d\u53ef\u6216\u7f3a\u7684\u5de5\u4f5c\u3002<\/p>\n<\/p>\n<p><h3>\u4e00\u3001\u7f16\u5199\u6e05\u6670\u7684API\u89c4\u8303<\/h3>\n<\/p>\n<p><h4>\u660e\u786e\u5b9a\u4e49API\u884c\u4e3a<\/h4>\n<\/p>\n<p><p>\u5728\u5f00\u53d1API\u4e4b\u521d\uff0c\u7f16\u5199\u4e00\u4efd\u6e05\u6670\u4e14\u8be6\u5c3d\u7684API\u89c4\u8303\u662f\u81f3\u5173\u91cd\u8981\u7684\u3002\u8fd9\u4efd\u89c4\u8303\u5e94\u660e\u786eAPI\u7684\u884c\u4e3a\u3001\u8f93\u5165\u8f93\u51fa\u6570\u636e\u683c\u5f0f\u3001\u9519\u8bef\u5904\u7406\u7b56\u7565\u4ee5\u53ca\u5b89\u5168\u8981\u6c42\u3002\u4f7f\u7528\u6807\u51c6\u5316\u7684\u89c4\u8303\u6587\u6863\uff0c\u5982OpenAPI\uff08Swagger\uff09\uff0c\u53ef\u4ee5\u5e2e\u52a9\u56e2\u961f\u6210\u5458\u7406\u89e3\u548c\u9075\u5faa\u5171\u540c\u7684\u6307\u5357\u3002<\/p>\n<\/p>\n<p><h4>\u89c4\u8303\u4e2d\u7684\u7248\u672c\u63a7\u5236<\/h4>\n<\/p>\n<p><p>\u5728\u89c4\u8303\u4e2d\u660e\u786e\u5730\u63cf\u8ff0API\u7684\u7248\u672c\u63a7\u5236\u7b56\u7565\u53ef\u4ee5\u5e2e\u52a9\u5f00\u53d1\u8005\u5904\u7406\u5411\u540e\u517c\u5bb9\u95ee\u9898\uff0c\u51cf\u8f7b\u524d\u7aef\u4e0e\u540e\u7aef\u95f4\u65ad\u6027\u5347\u7ea7\u6240\u5e26\u6765\u7684\u98ce\u9669\u3002<\/p>\n<\/p>\n<p><h3>\u4e8c\u3001\u5b9e\u65bd\u4ee3\u7801\u5ba1\u67e5<\/h3>\n<\/p>\n<p><h4>\u4ee3\u7801\u5ba1\u67e5\u7684\u5b9e\u8df5<\/h4>\n<\/p>\n<p><p>\u4ee3\u7801\u5ba1\u67e5(process)\u662f\u589e\u8fdb\u4ee3\u7801\u8d28\u91cf\u4ee5\u53ca\u56e2\u961f\u4e4b\u95f4\u6c9f\u901a\u7684\u6709\u6548\u9014\u5f84\u3002\u901a\u8fc7\u5ba1\u6838\u540c\u4f34\u7684\u4ee3\u7801\uff0c\u53ef\u4ee5\u6355\u83b7\u6f5c\u5728\u7684\u9519\u8bef\u3001\u6539\u5584\u4ee3\u7801\u5b9e\u73b0\uff0c\u5e76\u4fdd\u6301\u4ee3\u7801\u98ce\u683c\u7684\u4e00\u81f4\u6027\u3002<\/p>\n<\/p>\n<p><h4>\u81ea\u52a8\u5316\u5de5\u5177\u8f85\u52a9<\/h4>\n<\/p>\n<p><p>\u5229\u7528\u81ea\u52a8\u5316\u7684\u4ee3\u7801\u5ba1\u67e5\u5de5\u5177\uff0c\u5982SonarQube\u6216CodeClimate\uff0c\u53ef\u4ee5\u6807\u51c6\u5316\u5ba1\u67e5\u8fc7\u7a0b\uff0c\u5e76\u51cf\u8f7b\u4eba\u5de5\u5ba1\u6838\u7684\u8d1f\u62c5\u3002<\/p>\n<\/p>\n<p><h3>\u4e09\u3001\u8fd0\u7528\u81ea\u52a8\u5316\u6d4b\u8bd5<\/h3>\n<\/p>\n<p><h4>\u5355\u5143\u6d4b\u8bd5<\/h4>\n<\/p>\n<p><p>\u7f16\u5199\u5355\u5143\u6d4b\u8bd5\u53ef\u786e\u4fddAPI\u7684\u6bcf\u4e2a\u5c0f\u7ec4\u4ef6\u6309\u9884\u671f\u5de5\u4f5c\u3002\u5355\u5143\u6d4b\u8bd5\u5e94\u8986\u76d6API\u7aef\u70b9\u7684\u4e3b\u8981\u529f\u80fd\uff0c\u5e76\u80fd\u591f\u5feb\u901f\u6267\u884c\uff0c\u4ee5\u4fbf\u9891\u7e41\u8fd0\u884c\u4e8e\u5f00\u53d1\u5468\u671f\u4e2d\u3002<\/p>\n<\/p>\n<p><h4>\u96c6\u6210\u6d4b\u8bd5\u4e0e\u8d1f\u8f7d\u6d4b\u8bd5<\/h4>\n<\/p>\n<p><p>\u96c6\u6210\u6d4b\u8bd5\u9a8c\u8bc1API\u7ec4\u4ef6\u95f4\u7684\u76f8\u4e92\u4f5c\u7528\uff0c\u800c\u8d1f\u8f7d\u6d4b\u8bd5\u5219\u4fdd\u8bc1API\u5728\u9ad8\u538b\u529b\u73af\u5883\u4e0b\u7684\u8868\u73b0\u3002\u8fd9\u6709\u52a9\u4e8e\u53d1\u73b0\u6027\u80fd\u74f6\u9888\u5e76\u9a8c\u8bc1\u7cfb\u7edf\u7684\u5f39\u6027\u3002<\/p>\n<\/p>\n<p><h3>\u56db\u3001\u8fdb\u884c\u6301\u7eed\u96c6\u6210<\/h3>\n<\/p>\n<p><h4>\u6301\u7eed\u96c6\u6210\u7684\u6846\u67b6<\/h4>\n<\/p>\n<p><p>\u91c7\u7528\u6301\u7eed\u96c6\u6210(CI)\u7684\u6846\u67b6\uff0c\u4f8b\u5982Jenkins\u6216CircleCI\uff0c\u53ef\u4ee5\u81ea\u52a8\u5316\u6d4b\u8bd5\u548c\u90e8\u7f72\u6d41\u7a0b\u3002\u5b83\u5141\u8bb8\u5f00\u53d1\u5c0f\u7ec4\u5728\u4ee3\u7801\u4ed3\u5e93\u4e2d\u5b9e\u65f6\u76d1\u63a7\u6bcf\u4e00\u6b21\u63d0\u4ea4\u7684\u5f71\u54cd\u3002<\/p>\n<\/p>\n<p><h4>\u81ea\u52a8\u5316\u90e8\u7f72<\/h4>\n<\/p>\n<p><p>\u7ed3\u5408\u6301\u7eed\u96c6\u6210\u7684\u81ea\u52a8\u5316\u90e8\u7f72\u786e\u4fddAPI\u7684\u65b0\u7248\u672c\u80fd\u8fc5\u901f\u4e14\u4e00\u81f4\u5730\u90e8\u7f72\u5230\u6240\u6709\u73af\u5883\u4e2d\uff0c\u4ece\u800c\u51cf\u5c11\u4eba\u4e3a\u9519\u8bef\u3002<\/p>\n<\/p>\n<p><h3>\u4e94\u3001\u7ef4\u62a4\u826f\u597d\u7684\u6587\u6863<\/h3>\n<\/p>\n<p><h4>\u53ca\u65f6\u66f4\u65b0\u6587\u6863<\/h4>\n<\/p>\n<p><p>API\u7684\u6587\u6863\u5e94\u53ca\u65f6\u66f4\u65b0\uff0c\u53cd\u6620\u6700\u65b0\u7684API\u53d8\u66f4\u3002\u826f\u597d\u7684\u6587\u6863\u4e0d\u4ec5\u6709\u52a9\u4e8e\u5916\u90e8\u5f00\u53d1\u8005\u7406\u89e3\u548c\u4f7f\u7528API\uff0c\u4e5f\u6709\u5229\u4e8e\u5185\u90e8\u5f00\u53d1\u8005\u7ef4\u62a4\u548c\u6269\u5c55API\u529f\u80fd\u3002<\/p>\n<\/p>\n<p><h4>\u4f7f\u7528\u6587\u6863\u751f\u6210\u5de5\u5177<\/h4>\n<\/p>\n<p><p>\u5229\u7528\u81ea\u52a8\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u5982Swagger UI\u6216Redoc\uff0c\u53ef\u4ee5\u786e\u4fdd\u6587\u6863\u7684\u51c6\u786e\u6027\u5e76\u51cf\u5c11\u624b\u52a8\u66f4\u65b0\u7684\u8d1f\u62c5\u3002<\/p>\n<\/p>\n<p><h3>\u516d\u3001\u76d1\u63a7API\u6027\u80fd<\/h3>\n<\/p>\n<p><h4>\u5b9e\u65f6\u76d1\u63a7<\/h4>\n<\/p>\n<p><p>\u901a\u8fc7\u5b9e\u65f6\u76d1\u63a7API\u7684\u6027\u80fd\uff0c\u5f00\u53d1\u56e2\u961f\u53ef\u4ee5\u5feb\u901f\u54cd\u5e94\u5ef6\u8fdf\u589e\u9ad8\u6216\u670d\u52a1\u4e2d\u65ad\u7684\u95ee\u9898\u3002\u4f7f\u7528APM\uff08\u5e94\u7528\u6027\u80fd\u7ba1\u7406\uff09\u5de5\u5177\uff0c\u5982New Relic\u6216Datadog\uff0c\u53ef\u4ee5\u8ddf\u8e2a\u5173\u952e\u6307\u6807\u5e76\u5728\u51fa\u73b0\u95ee\u9898\u65f6\u53d1\u51fa\u8b66\u62a5\u3002<\/p>\n<\/p>\n<p><h4>\u65e5\u5fd7\u5206\u6790<\/h4>\n<\/p>\n<p><p>\u7ef4\u62a4\u8be6\u7ec6\u7684API\u65e5\u5fd7\uff0c\u5e76\u5229\u7528\u65e5\u5fd7\u5206\u6790\u5de5\u5177\uff0c\u5982ELK Stack\uff0c\u5e2e\u52a9\u56e2\u961f\u4e86\u89e3API\u7684\u4f7f\u7528\u6a21\u5f0f\u548c\u6f5c\u5728\u95ee\u9898\uff0c\u4ece\u800c\u8fdb\u884c\u4f18\u5316\u3002<\/p>\n<\/p>\n<h2><strong>\u76f8\u5173\u95ee\u7b54FAQs\uff1a<\/strong><\/h2>\n<p><strong>1. API\u4ee3\u7801\u8d28\u91cf\u7684\u91cd\u8981\u6027\u662f\u4ec0\u4e48\uff1f<\/strong><\/p>\n<p>\u826f\u597d\u7684API\u4ee3\u7801\u8d28\u91cf\u5bf9\u4e8e\u5e94\u7528\u7a0b\u5e8f\u7684\u7a33\u5b9a\u6027\u3001\u53ef\u9760\u6027\u548c\u53ef\u7ef4\u62a4\u6027\u975e\u5e38\u91cd\u8981\u3002\u9ad8\u8d28\u91cf\u7684API\u4ee3\u7801\u6709\u52a9\u4e8e\u51cf\u5c11bug\u7684\u6570\u91cf\u5e76\u63d0\u5347\u5e94\u7528\u7a0b\u5e8f\u7684\u6027\u80fd\u3002\u5b83\u8fd8\u53ef\u4ee5\u589e\u52a0\u5f00\u53d1\u4eba\u5458\u7684\u5de5\u4f5c\u6548\u7387\uff0c\u5e76\u7b80\u5316\u5e94\u7528\u7a0b\u5e8f\u7684\u6d4b\u8bd5\u548c\u7ef4\u62a4\u8fc7\u7a0b\u3002<\/p>\n<p><strong>2. \u63d0\u9ad8API\u4ee3\u7801\u8d28\u91cf\u7684\u5173\u952e\u6280\u5de7\u662f\u4ec0\u4e48\uff1f<\/strong><\/p>\n<p>\u8981\u786e\u4fddAPI\u4ee3\u7801\u8d28\u91cf\uff0c\u9996\u5148\u5e94\u8be5\u7f16\u5199\u6e05\u6670\u3001\u6613\u4e8e\u7406\u89e3\u7684\u4ee3\u7801\u3002\u4f7f\u7528\u6709\u610f\u4e49\u7684\u53d8\u91cf\u548c\u51fd\u6570\u547d\u540d\uff0c\u9075\u5faa\u4e00\u81f4\u548c\u89c4\u8303\u7684\u7f16\u7801\u98ce\u683c\u3002\u6b64\u5916\uff0c\u5e94\u8be5\u7f16\u5199\u8be6\u7ec6\u7684\u6ce8\u91ca\u548c\u6587\u6863\uff0c\u4ee5\u4fbf\u5176\u4ed6\u5f00\u53d1\u4eba\u5458\u80fd\u591f\u8f7b\u677e\u7406\u89e3\u5982\u4f55\u4f7f\u7528API\u3002\u8fdb\u884c\u4ee3\u7801\u5ba1\u67e5\u548c\u5355\u5143\u6d4b\u8bd5\u4e5f\u662f\u63d0\u9ad8API\u4ee3\u7801\u8d28\u91cf\u7684\u5173\u952e\u6b65\u9aa4\u3002<\/p>\n<p><strong>3. \u5982\u4f55\u8bc4\u4f30API\u4ee3\u7801\u8d28\u91cf\uff1f<\/strong><\/p>\n<p>\u8bc4\u4f30API\u4ee3\u7801\u8d28\u91cf\u7684\u4e00\u79cd\u65b9\u6cd5\u662f\u8fdb\u884c\u4ee3\u7801\u9759\u6001\u5206\u6790\u3002\u9759\u6001\u4ee3\u7801\u5206\u6790\u5de5\u5177\u53ef\u4ee5\u5e2e\u52a9\u68c0\u67e5\u4ee3\u7801\u4e2d\u7684\u6f5c\u5728\u9519\u8bef\u3001\u4ee3\u7801\u5197\u4f59\u548c\u4f4e\u6548\u6027\u7b49\u95ee\u9898\u3002\u53e6\u5916\uff0c\u901a\u8fc7\u6267\u884c\u6d4b\u8bd5\u5957\u4ef6\u6765\u8bc4\u4f30API\u7684\u529f\u80fd\u548c\u6027\u80fd\u4e5f\u662f\u975e\u5e38\u91cd\u8981\u7684\u3002\u53ef\u4ee5\u4f7f\u7528\u81ea\u52a8\u5316\u6d4b\u8bd5\u6846\u67b6\u6765\u8fd0\u884c\u5404\u79cd\u6d4b\u8bd5\u7528\u4f8b\uff0c\u5e76\u8bc4\u4f30\u4ee3\u7801\u5728\u4e0d\u540c\u8d1f\u8f7d\u548c\u8fb9\u754c\u6761\u4ef6\u4e0b\u7684\u8868\u73b0\u3002\u5b9a\u671f\u8fdb\u884c\u4ee3\u7801\u5ba1\u67e5\u548c\u6027\u80fd\u5206\u6790\u662f\u8bc4\u4f30API\u4ee3\u7801\u8d28\u91cf\u7684\u53e6\u4e00\u79cd\u65b9\u6cd5\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"\u786e\u4fddAPI\u7684\u4ee3\u7801\u8d28\u91cf\u7684\u5173\u952e\u6b65\u9aa4\u5305\u62ec\u7f16\u5199\u6e05\u6670\u7684API\u89c4\u8303\u3001\u5b9e\u65bd\u4ee3\u7801\u5ba1\u67e5\u3001\u8fd0\u7528\u81ea\u52a8\u5316\u6d4b\u8bd5\u3001\u8fdb\u884c\u6301\u7eed\u96c6\u6210\u3001\u7ef4\u62a4\u826f\u597d\u7684 [&hellip;]","protected":false},"author":3,"featured_media":116261,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[37],"tags":[],"acf":[],"_links":{"self":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/116257"}],"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\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/comments?post=116257"}],"version-history":[{"count":0,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/116257\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media\/116261"}],"wp:attachment":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media?parent=116257"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/categories?post=116257"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/tags?post=116257"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}