{"id":205332,"date":"2025-05-29T09:45:02","date_gmt":"2025-05-29T01:45:02","guid":{"rendered":"https:\/\/server.hk\/cnblog\/205332\/"},"modified":"2025-05-29T09:45:02","modified_gmt":"2025-05-29T01:45:02","slug":"api-%e8%ae%be%e8%ae%a1%e7%9a%84%e8%89%ba%e6%9c%af%ef%bc%9a%e4%bd%bf%e7%94%a8-nodejs-%e5%88%9b%e5%bb%ba%e6%9c%89%e6%95%88%e7%9a%84-restful-api","status":"publish","type":"post","link":"https:\/\/server.hk\/cnblog\/205332\/","title":{"rendered":"API \u8bbe\u8ba1\u7684\u827a\u672f\uff1a\u4f7f\u7528 Nodejs \u521b\u5efa\u6709\u6548\u7684 RESTful API"},"content":{"rendered":"<p><b><\/b>     <\/p>\n<h1>API \u8bbe\u8ba1\u7684\u827a\u672f\uff1a\u4f7f\u7528 Nodejs \u521b\u5efa\u6709\u6548\u7684 RESTful API<\/h1>\n<p>\u4f60\u5728\u5b66\u4e60<span style=\"color: #FF6600;, Helvetica, Arial, sans-serif;font-size: 14px;background-color: #FFFFFF\">\u6587\u7ae0<\/span>\u76f8\u5173\u7684\u77e5\u8bc6\u5417\uff1f\u672c\u6587<span style=\"color: #FF6600;, Helvetica, Arial, sans-serif;font-size: 14px;background-color: #FFFFFF\">\u300aAPI \u8bbe\u8ba1\u7684\u827a\u672f\uff1a\u4f7f\u7528 Nodejs \u521b\u5efa\u6709\u6548\u7684 RESTful API\u300b<\/span>\uff0c\u4e3b\u8981\u4ecb\u7ecd\u7684\u5185\u5bb9\u5c31\u6d89\u53ca\u5230<span style=\"color: #FF6600;, Helvetica, Arial, sans-serif;font-size: 14px;background-color: #FFFFFF\"><\/span>\uff0c\u5982\u679c\u4f60\u60f3\u63d0\u5347\u81ea\u5df1\u7684\u5f00\u53d1\u80fd\u529b\uff0c\u5c31\u4e0d\u8981\u9519\u8fc7\u8fd9\u7bc7\u6587\u7ae0\uff0c\u5927\u5bb6\u8981\u77e5\u9053\u7f16\u7a0b\u7406\u8bba\u57fa\u7840\u548c\u5b9e\u6218\u64cd\u4f5c\u90fd\u662f\u4e0d\u53ef\u6216\u7f3a\u7684\u54e6\uff01<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/www.17golang.com\/uploads\/20241129\/17328480136749298d80dd4.jpg\" class=\"aligncenter\"><\/p>\n<p>\u5728 Web \u5f00\u53d1\u7684\u52a8\u6001\u4e16\u754c\u4e2d\uff0c\u53ef\u6269\u5c55\u4e14\u9ad8\u6548\u7684\u5e94\u7528\u7a0b\u5e8f\u5fc5\u987b\u5efa\u7acb\u5728 API \u8bbe\u8ba1\u7684\u575a\u5b9e\u57fa\u7840\u4e0a\u3002\u968f\u7740\u5bf9 RESTful API \u7684\u9700\u6c42\u4e0d\u65ad\u589e\u52a0\uff0cNode.js \u73b0\u5df2\u6210\u4e3a\u6784\u5efa\u9ad8\u6027\u80fd\u3001\u4e8b\u4ef6\u9a71\u52a8\u7684 API \u6765\u670d\u52a1\u5927\u91cf\u5e76\u53d1\u8bf7\u6c42\u7684\u5f3a\u5927\u529b\u91cf\u3002\u4ee5\u4e0b\u90e8\u5206\u5b9e\u9645\u4e0a\u6df1\u5165\u7814\u7a76\u4e86\u4f7f\u7528 Node.js \u8fdb\u884c\u6709\u6548 API \u8bbe\u8ba1\u7684\u539f\u5219\uff0c\u8fd9\u5bf9\u5f00\u53d1\u4eba\u5458\u6709\u5f88\u5927\u7684\u5e2e\u52a9\u548c\u76f8\u5173\u6027\uff0c\u7279\u522b\u662f\u5bf9\u4e8e\u90a3\u4e9b\u5728\u6d77\u5f97\u62c9\u5df4\u5b66\u4e60 Java \u5f00\u53d1\u8bfe\u7a0b\u7684\u4eba\u3002<\/p>\n<p><strong>\u76ee\u5f55<\/strong><\/p>\n<p>\u4e86\u89e3 RESTful API \u8bbe\u8ba1<br \/> \u9009\u62e9\u6b63\u786e\u7684 HTTP \u65b9\u6cd5<br \/> 2.1 \u83b7\u53d6\u3001\u53d1\u5e03\u3001\u653e\u7f6e\u3001\u4fee\u8865\u548c\u5220\u9664<br \/> 2.2 \u5c06HTTP\u65b9\u6cd5\u4e0eCRUD\u64cd\u4f5c\u76f8\u5339\u914d<br \/> \u8bbe\u8ba1\u76f4\u89c2\u7684 API \u7aef\u70b9<br \/> 3.1 \u7aef\u70b9\u7684\u547d\u540d\u7ea6\u5b9a<br \/> 3.2 \u5bf9 API \u8fdb\u884c\u7248\u672c\u63a7\u5236<br \/> \u5904\u7406\u8bf7\u6c42\u548c\u54cd\u5e94<br \/> 4.1 \u89e3\u6790\u8bf7\u6c42\u6570\u636e<br \/> 4.2 \u53d1\u9001\u9002\u5f53\u7684\u54cd\u5e94<br \/> \u5b9e\u65bd\u8eab\u4efd\u9a8c\u8bc1\u548c\u6388\u6743<br \/> 5.1 \u57fa\u672c\u8eab\u4efd\u9a8c\u8bc1<br \/> 5.2 \u4f7f\u7528 JWT \u57fa\u4e8e\u4ee4\u724c\u7684\u8eab\u4efd\u9a8c\u8bc1<br \/> \u9519\u8bef\u5904\u7406\u548c\u65e5\u5fd7\u8bb0\u5f55<br \/> 6.1 \u8fd4\u56de\u6709\u610f\u4e49\u7684\u9519\u8bef\u6d88\u606f<br \/> 6.2 \u8c03\u8bd5\u65e5\u5fd7<br \/> 7.1 \u4f7f\u7528 Swagger \u548c Postman<br \/> 7.2 \u7ef4\u62a4\u5b9e\u65f6\u6587\u6863<br \/> \u6d4b\u8bd5\u60a8\u7684 API<br \/> 8.1 \u4f7f\u7528 Mocha \u548c Chai \u8fdb\u884c\u5355\u5143\u6d4b\u8bd5<br \/> 8.2 \u4f7f\u7528 Supertest \u8fdb\u884c\u96c6\u6210\u6d4b\u8bd5<br \/> \u90e8\u7f72\u60a8\u7684 API<br \/> 9.1 \u4e91\u7aef Node.js API<br \/> 9.2 \u96c6\u7fa4\u548c\u8d1f\u8f7d\u5e73\u8861\uff1a\u6269\u5c55\u60a8\u7684 API<br \/> \u826f\u597d API \u8bbe\u8ba1\u7684\u6700\u4f73\u5b9e\u8df5<\/p>\n<p><strong>\u4e86\u89e3 RESTful API \u8bbe\u8ba1<\/strong><\/p>\n<p>RESTful API \u8bbe\u8ba1\u662f\u6307\u521b\u5efa Web \u670d\u52a1\u65f6\u7684\u4e00\u7ec4\u51c6\u5219\u548c\u7ea6\u675f\u3002 REST API \u662f\u4f7f\u7528 HTTP \u65b9\u6cd5\u7684\u7f51\u7edc\u670d\u52a1\uff0c\u53ef\u9488\u5bf9 URI \u6807\u8bc6\u7684\u8d44\u6e90\u8fdb\u884c\u64cd\u4f5c\uff0c\u4ee5\u6267\u884c\u6807\u51c6 CRUD \u64cd\u4f5c\u3002\u8fd9\u6837\uff0c\u65e0\u8bba\u8c01\u5b9e\u73b0\u8fd9\u4e9b\u539f\u5219\uff0c\u90fd\u53ef\u4ee5\u5f97\u5230\u53ef\u6269\u5c55\u3001\u53ef\u7ef4\u62a4\u4e14\u6613\u4e8e\u7406\u89e3\u7684 API\u3002<\/p>\n<p>\u7531\u4e8e\u5176\u4e8b\u4ef6\u9a71\u52a8\u67b6\u6784\u548c\u975e\u963b\u585e I\/O\uff0cNode.js \u662f\u6784\u5efa RESTful API \u7684\u5b8c\u7f8e\u9009\u62e9\u4e4b\u4e00\u3002\u80fd\u591f\u540c\u65f6\u5904\u7406\u5927\u91cf\u8fde\u63a5\u5e76\u63d0\u4f9b\u5305\u542b\u5e93\u548c\u6846\u67b6\u7684\u5e9e\u5927\u751f\u6001\u7cfb\u7edf\u662f\u8be5\u6280\u672f\u5728\u5f00\u53d1\u4eba\u5458\u4e2d\u975e\u5e38\u53d7\u6b22\u8fce\u7684\u539f\u56e0\u3002<\/p>\n<p><strong>\u5728 HTTP \u4e2d\u9009\u62e9\u6b63\u786e\u7684\u65b9\u6cd5<\/strong><\/p>\n<p>\u83b7\u53d6\u3001\u53d1\u5e03\u3001\u653e\u7f6e\u3001\u4fee\u8865\u3001\u5220\u9664<br \/> HTTP \u65b9\u6cd5\u662f RESTful API \u8bbe\u8ba1\u7684\u57fa\u77f3\uff0c\u6839\u636e\u8bf7\u6c42\u7684\u76ee\u7684\u4e00\u81f4\u5e94\u7528\uff0c\u5982\u4e0b\u6240\u793a\uff1a GET\uff1a\u7528\u4e8e\u8bfb\u53d6\u8d44\u6e90\u6216\u5176\u8868\u793a\uff1b POST\uff1a\u7528\u4e8e\u521b\u5efa\u65b0\u8d44\u6e90\u6216\u5c06\u6570\u636e\u53d1\u5e03\u5230\u670d\u52a1\u5668\uff1b PUT\uff1a\u7528\u4e8e\u5bf9\u73b0\u6709\u8d44\u6e90\u8fdb\u884c\u66f4\u65b0\uff1b PATCH\uff1a\u5bf9\u73b0\u6709\u8d44\u6e90\u8fdb\u884c\u90e8\u5206\u66f4\u65b0\uff1b DELETE\uff1a\u5220\u9664\u8d44\u6e90\u3002\u8fd9\u4e9b\u65b9\u6cd5\u4e2d\u7684\u6bcf\u4e00\u79cd\u90fd\u88ab\u4e00\u81f4\u5730\u5e94\u7528\u3002\u8fd9\u662f\u4e3a\u4e86\u4f7f\u5ba2\u6237\u7aef\u80fd\u591f\u4ee5\u53ef\u9884\u6d4b\u4e14\u76f4\u89c2\u7684\u65b9\u5f0f\u4f7f\u7528 API\u3002<\/p>\n<p><strong>\u5c06 HTTP \u65b9\u6cd5\u4e0e CRUD \u64cd\u4f5c\u76f8\u5339\u914d<\/strong><\/p>\n<p>\u4e3a\u4e86\u4fdd\u8bc1\u53ef\u8bfb\u6027\u548c\u4e00\u81f4\u6027\uff0c\u5fc5\u987b\u5c06 HTTP \u65b9\u6cd5\u4e0e\u5176\u5bf9\u5e94\u7684 C-R-U-D \u64cd\u4f5c\u76f8\u5339\u914d\uff1a<br \/> \u83b7\u53d6\uff1a\u9605\u8bfb<br \/> \u5e16\u5b50\uff1a\u521b\u5efa<br \/> PUT\uff1a\u66f4\u65b0 &#8211; \u66ff\u6362<br \/> \u8865\u4e01\uff1a\u66f4\u65b0 &#8211; \u90e8\u5206 <br \/> \u5220\u9664\uff1a\u5220\u9664<\/p>\n<p>\u5c06\u60a8\u7684 API \u64cd\u4f5c\u4e0e\u6b63\u786e\u7684 HTTP \u65b9\u6cd5\u7ed3\u5408\u8d77\u6765\u5c06\u4ea7\u751f\u4e00\u4e2a\u975e\u5e38\u7528\u6237\u53cb\u597d\u4e14\u76f4\u89c2\u7684 API\uff0c\u4f7f\u5176\u6613\u4e8e\u7406\u89e3\u548c\u4f7f\u7528\u3002<br \/> \u8bbe\u8ba1\u76f4\u89c2\u7684 API \u7aef\u70b9<br \/> \u547d\u540d\u7ea6\u5b9a<br \/> API \u7aef\u70b9\u5e94\u9075\u5faa\u4e00\u81f4\u3001\u6e05\u6670\u7684\u8bbe\u8ba1\u3002\u4f7f\u7528\u4e0e\u540d\u8bcd\u4e00\u81f4\u7684\u540d\u79f0\uff0c\u8fd9\u5c06\u6e05\u695a\u5730\u6807\u8bc6\u6b63\u5728\u8bbf\u95ee\u7684\u8d44\u6e90\u3002\u4f8b\u5982\uff0c\u8fd9\u53ef\u80fd\u5982\u4e0b\u6240\u793a\uff1a\/users \u8868\u793a\u7528\u6237\u96c6\u5408\uff0c\/users\/:id \u8868\u793a\u5355\u4e2a\u7528\u6237\u3002\u907f\u514d\u4f7f\u7528\u52a8\u8bcd\u547d\u540d\u7aef\u70b9\uff0c\u56e0\u4e3a via the<\/p>\n<p>HTTP\u65b9\u6cd5\uff0c\u5f88\u6e05\u695a\u6b63\u5728\u6267\u884c\u4ec0\u4e48\u64cd\u4f5c\u3002\u96c6\u5408\u5c06\u4f7f\u7528\u540d\u8bcd\u7684\u590d\u6570\u5f62\u5f0f\u548c\u5355\u6570\u6765\u547d\u540d<\/p>\n<p><strong>\u4ee3\u8868\u5355\u4e2a\u8d44\u6e90\u65f6\u7684\u540d\u8bcd\u5f62\u5f0f\u3002<\/strong><\/p>\n<p>\u60a8\u9700\u8981\u5bf9\u6b64 API \u8fdb\u884c\u7248\u672c\u63a7\u5236\uff0c\u4ee5\u4fbf\u5728\u60a8\u6539\u8fdb API \u65f6\uff0c\u65e9\u671f\u7248\u672c\u4f1a\u7ee7\u7eed\u8fd0\u884c\u5e76\u4e14\u4e0d\u4f1a\u56e0\u66f4\u6539\u800c\u4e2d\u65ad\u3002\u786e\u4fdd\u4f7f\u7528\u975e\u5e38\u4e00\u81f4\u7684\u7248\u672c\u63a7\u5236\u65b9\u6848\u6765\u6307\u793a API \u7684\u7248\u672c\uff0c\u4f8b\u5982 \/v1\/users\u3001\/api\/v1\/users\uff0c&#8230;<br \/> \u5728\u8fdb\u884c\u91cd\u5927\u66f4\u6539\u65f6\uff0c\u5f15\u5165\u65b0\u7248\u672c\u7684 API \u5e76\u8d2c\u503c\u65e7\u7248\u672c\u3002\u8fd9\u6837\uff0c\u5ba2\u6237\u53ef\u4ee5\u6309\u7167\u81ea\u5df1\u7684\u8282\u594f\u8fc1\u79fb\u5230\u65b0\u7248\u672c\uff0c\u800c\u65e7\u7248\u672c\u4ecd\u5c06\u4fdd\u6301\u529f\u80fd\u3002<\/p>\n<p><strong>\u5904\u7406\u8bf7\u6c42\u548c\u54cd\u5e94<\/strong><\/p>\n<p><strong>\u89e3\u6790\u8bf7\u6c42\u6570\u636e<\/strong><\/p>\n<p>\u59cb\u7ec8\u89e3\u6790\u548c\u9a8c\u8bc1\u4f20\u5165\u6570\u636e\uff0c\u4ee5\u786e\u8ba4\u5176\u5728 API \u4e2d\u7684\u9002\u7528\u6027\u3002\u6b63\u6587\u89e3\u6790\u4e2d\u95f4\u4ef6\u6709\u52a9\u4e8e\u89e3\u6790 JSON \u683c\u5f0f\u7684\u4f20\u5165\u8bf7\u6c42\u6b63\u6587\u3002 &nbsp;<br \/> \u4f7f\u7528 Joi \u6216\u9a8c\u8bc1\u5668\u7b49\u5e93\u6839\u636e API \u67b6\u6784\u548c\u4e1a\u52a1\u89c4\u5219\u9a8c\u8bc1\u4f20\u5165\u6570\u636e\u3002\u8fd9\u51cf\u5c11\u4e86\u6f5c\u5728\u7684\u9519\u8bef\u5e76\u786e\u4fdd\u6570\u636e\u5b8c\u6574\u6027\u3002 <br \/> &nbsp;<br \/><strong>\u8fd4\u56de\u9002\u5f53\u7684\u56de\u590d<\/strong><\/p>\n<p>\u786e\u4fdd\u60a8\u7684\u54cd\u5e94\u8fd4\u56de\u9002\u5f53\u7684 HTTP \u72b6\u6001\u4ee3\u7801\u6765\u6307\u793a\u8bf7\u6c42\u7684\u7ed3\u679c\uff0c\u4f8b\u5982\uff1a200 OK \u8868\u793a GET \u8bf7\u6c42\u6210\u529f\uff0c201 Created \u8868\u793a\u6210\u529f\u7684 POST \u8bf7\u6c42\uff0c204 No Content \u8868\u793a\u6210\u529f\u7684 DELETE \u8bf7\u6c42\u3002<br \/> \u4ee5 JSON \u5f62\u5f0f\u8fd4\u56de\u6570\u636e\uff0c\u5e76\u4e0e API \u4e2d\u7684\u54cd\u5e94\u7ed3\u6784\u4fdd\u6301\u4e00\u81f4\u3002\u6dfb\u52a0\u6709\u5173\u5206\u9875\u4fe1\u606f\u6216\u9519\u8bef\u6d88\u606f\u7684\u9644\u52a0\u5143\u6570\u636e\uff0c\u4e3a\u5ba2\u6237\u7aef\u63d0\u4f9b\u4e0a\u4e0b\u6587\u3002<\/p>\n<p><strong>\u5b9e\u73b0\u8eab\u4efd\u9a8c\u8bc1\u548c\u6388\u6743<\/strong><\/p>\n<p><strong>\u57fa\u672c\u8eab\u4efd\u9a8c\u8bc1<\/strong><\/p>\n<p>\u57fa\u672c\u8eab\u4efd\u9a8c\u8bc1\u662f\u4f7f\u7528\u7528\u6237\u540d\u548c\u5bc6\u7801\u5bf9\u5ba2\u6237\u7aef\u8fdb\u884c\u8eab\u4efd\u9a8c\u8bc1\u7684\u6700\u7b80\u5355\u65b9\u6cd5\u3002\u5b83\u5f88\u5bb9\u6613\u5b89\u88c5\uff0c\u4f46\u4e0d\u9002\u5408\u751f\u4ea7\u4f7f\u7528\uff0c\u56e0\u4e3a\u5b83\u4e0d\u5305\u542b\u4efb\u4f55\u5b89\u5168\u529f\u80fd\u3002\u4f7f\u7528 JWT \u57fa\u4e8e\u4ee4\u724c\u7684\u8eab\u4efd\u9a8c\u8bc1<br \/> JSON Web \u4ee4\u724c\u6bd4\u57fa\u672c\u8eab\u4efd\u9a8c\u8bc1\u66f4\u5b89\u5168\u4e14\u53ef\u6269\u5c55\u3002 JWT\u901a\u8fc7\u53d1\u5e03\u5305\u542b\u7528\u6237\u4fe1\u606f\u548c\u6743\u9650\u7684\u7b7e\u540d\u4ee4\u724c\u6765\u5b9e\u73b0\u5ba2\u6237\u7aef\u7684\u8eab\u4efd\u9a8c\u8bc1\u548c\u6388\u6743\u3002<br \/> \u5f53\u5ba2\u6237\u7aef\u4f7f\u7528\u60a8\u7684 API \u8fdb\u884c\u8eab\u4efd\u9a8c\u8bc1\u65f6\uff0c\u8fd4\u56de JWT\uff1b\u540e\u8005\u5c06\u5728\u540e\u7eed\u8bf7\u6c42\u4e2d\u5305\u542b\u6b64\u4ee4\u724c\u3002\u5728\u670d\u52a1\u5668\u7aef\uff0c\u9a8c\u8bc1token\u7684\u7b7e\u540d\uff0c\u4ee5\u4e86\u89e3\u5b83\u662f\u5426\u6709\u6548\u6216\u5df2\u88ab\u7be1\u6539\u3002<\/p>\n<p><strong>\u9519\u8bef\u5904\u7406\u548c\u65e5\u5fd7\u8bb0\u5f55<\/strong><\/p>\n<p><strong>\u4e00\u5b9a\u8981\u8fd4\u56de\u6709\u610f\u4e49\u7684\u9519\u8bef\u6d88\u606f<\/strong><\/p>\n<p>\u5982\u679c\u51fa\u73b0\u4efb\u4f55\u9519\u8bef\uff0c\u5b83\u5e94\u8be5\u5411\u5ba2\u6237\u7aef\u8fd4\u56de\u6709\u610f\u4e49\u7684\u9519\u8bef\u6d88\u606f\uff0c\u5176\u4e2d\u5305\u542b\u8db3\u591f\u7684\u4fe1\u606f\u7528\u4e8e\u8bca\u65ad\u548c\u89e3\u51b3\u95ee\u9898\u3002\u4e3a\u9519\u8bef\u7c7b\u578b\u8bbe\u7f6e\u6b63\u786e\u7684 HTTP \u72b6\u6001\u4ee3\u7801\uff1a400 Bad Request \u8868\u793a\u5ba2\u6237\u7aef\u9519\u8bef\uff0c500 Internal Server Error \u8868\u793a\u670d\u52a1\u5668\u7aef\u9519\u8bef\u3002<br \/> \u5305\u542b\u6bcf\u6761\u76f8\u5173\u9519\u8bef\u4fe1\u606f\uff1a\u4f8b\u5982\uff0c\u9519\u8bef\u4ee3\u7801\u3001\u6d88\u606f\u4ee5\u53ca\u54cd\u5e94\u6b63\u6587\u53ef\u80fd\u5305\u542b\u7684\u4efb\u4f55\u5176\u4ed6\u4e0a\u4e0b\u6587\u3002\u5305\u542b\u6b64\u7c7b\u4fe1\u606f\u53ef\u80fd\u4f1a\u5e2e\u52a9\u5ba2\u6237\u8bc6\u522b\u51fa\u4e86\u4ec0\u4e48\u95ee\u9898\u4ee5\u53ca\u5982\u4f55\u4fee\u590d\u5b83\u3002<\/p>\n<p><strong>\u7528\u4e8e\u8c03\u8bd5\u548c\u76d1\u63a7\u7684\u65e5\u5fd7\u8bb0\u5f55<\/strong><\/p>\n<p>\u5728\u5e94\u7528\u7a0b\u5e8f\u4e2d\u8bbe\u7f6e\u826f\u597d\u7684\u65e5\u5fd7\u8bb0\u5f55\u673a\u5236\uff0c\u4ee5\u8bb0\u5f55\u6267\u884c\u8fc7\u7a0b\u4e2d\u7684\u9519\u8bef\u3001\u8b66\u544a\u548c\u91cd\u8981\u4e8b\u4ef6\u3002\u4f7f\u7528\u597d\u7684\u65e5\u5fd7\u5e93\uff0c\u5982 morgan \u6216 Winston\uff0c\u6765\u8bb0\u5f55\u8bf7\u6c42\/\u54cd\u5e94\/\u9519\u8bef\u3002<br \/> \u5c06\u65e5\u5fd7\u4fdd\u5b58\u5728\u4e00\u4e2a\u4f4d\u7f6e\uff08\u6587\u4ef6\u6216\u65e5\u5fd7\u8bb0\u5f55\u670d\u52a1\uff09\uff0c\u4ee5\u4fbf\u4e8e\u8c03\u8bd5\u548c\u76d1\u63a7\u3002\u7136\u540e\uff0c\u8bbe\u7f6e\u65e5\u5fd7\u7ea7\u522b\u6765\u5904\u7406\u91cd\u8981\u6d88\u606f\u5e76\u5ffd\u7565\u591a\u4f59\u7684\u566a\u97f3\u3002<\/p>\n<p><strong>\u8bb0\u5f55\u4f60\u7684API<\/strong><\/p>\n<p><strong>\u4f7f\u7528Swagger\u548cPostman\u7b49\u5de5\u5177<\/strong><\/p>\n<p>\u4e3a API \u5236\u4f5c\u5b8c\u6574\u7684\u6587\u6863\uff0c\u4ee5\u4fbf\u6240\u6709\u9047\u5230\u5b83\u7684\u7528\u6237\u90fd\u77e5\u9053\u5982\u4f55\u4f7f\u7528\u5b83\u3002\u4f7f\u7528 Swagger \u548c Postman \u7b49\u5de5\u5177\u7684\u81ea\u52a8\u5316\u4ea4\u4e92\u5f0f\u6587\u6863\u4e3a\u60a8\u63d0\u4f9b\u7aef\u70b9\u3001\u8bf7\u6c42\u3001\u54cd\u5e94\u793a\u4f8b\uff0c\u751a\u81f3\u6709\u5173\u5982\u4f55\u8fdb\u884c\u8eab\u4efd\u9a8c\u8bc1\u7684\u8be6\u7ec6\u4fe1\u606f\u3002\u4fdd\u6301\u6587\u6863\u66f4\u65b0\u5e76\u9075\u5faa API \u4e2d\u6240\u505a\u7684\u66f4\u6539\uff0c\u4ee5\u786e\u4fdd\u5ba2\u6237\u7aef\u62e5\u6709\u6709\u5173\u7aef\u70b9\u53ca\u5176\u4f7f\u7528\u60c5\u51b5\u7684\u6709\u6548\u4fe1\u606f\u3002<br \/> \u5b9a\u671f\u66f4\u65b0 API \u6587\u6863\u4ee5\u8ddf\u4e0a API \u7684\u66f4\u6539\u6216\u6dfb\u52a0\u4e5f\u5f88\u91cd\u8981\u3002\u53ef\u4ee5\u4e3a\u6bcf\u4e2a\u65b0\u529f\u80fd\u6216\u7f16\u8f91\u7684\u589e\u5f3a\u529f\u80fd\u542f\u52a8\u6587\u6863\u66f4\u65b0\u8fc7\u7a0b\u3002<\/p>\n<p>\u60a8\u751a\u81f3\u53ef\u4ee5\u4e3a\u60a8\u7684\u6587\u6863\u8bbe\u8ba1\u4e00\u4e2a\u7248\u672c\u63a7\u5236\u7cfb\u7edf\u3002\u8fd9\u610f\u5473\u7740\u60a8\u7684\u5ba2\u6237\u5c06\u80fd\u591f\u6839\u636e\u5176 API \u7248\u672c\u67e5\u770b\u6587\u6863\u7684\u7248\u672c\u3002<br \/> \u6d4b\u8bd5\u60a8\u7684 API<br \/> \u4f7f\u7528 Mocha \u548c Chai \u8fdb\u884c\u5355\u5143\u6d4b\u8bd5<br \/> \u4f7f\u7528\u5355\u5143\u6d4b\u8bd5\u6765\u6d4b\u8bd5 API\uff0c\u4ee5\u9a8c\u8bc1\u5355\u4e2a\u7ec4\u4ef6\u662f\u5426\u6309\u9884\u671f\u5de5\u4f5c\u3002\u60a8\u53ef\u4ee5\u4f7f\u7528 Mocha \u548c Chai \u7b49\u6d4b\u8bd5\u6846\u67b6\u7f16\u5199\u548c\u8fd0\u884c\u6d4b\u8bd5\u3002<br \/> \u4e3a\u6240\u6709\u7aef\u70b9\u7f16\u5199\u6d4b\u8bd5\uff0c\u786e\u4fdd\u9488\u5bf9\u4e0d\u540c\u7684\u8f93\u5165\u573a\u666f\u8fd4\u56de\u6b63\u786e\u7684\u54cd\u5e94\u3002\u68c0\u67e5\u8fb9\u7f18\u60c5\u51b5\u548c\u9519\u8bef\u6761\u4ef6\uff0c\u4ee5\u786e\u4fdd\u60a8\u7684 API \u80fd\u591f\u59a5\u5584\u5904\u7406\u5b83\u4eec\u3002<br \/> \u4e0e Supertest \u96c6\u6210\u6d4b\u8bd5<br \/> \u7f16\u5199\u96c6\u6210\u6d4b\u8bd5\u6765\u786e\u4fdd API \u7684\u6240\u6709\u90e8\u5206\u534f\u8c03\u5de5\u4f5c\u4e5f\u540c\u6837\u91cd\u8981\u3002 Supertest \u662f\u4e00\u4e2a\u4f18\u79c0\u7684\u5e93\uff0c\u7528\u4e8e\u5411 API \u53d1\u9001 HTTP \u8bf7\u6c42\u5e76\u6d4b\u8bd5\u54cd\u5e94\u3002<\/p>\n<p>\u5178\u578b\u7684\u7528\u4f8b\u573a\u666f\u5e94\u8be5\u6709\u6d4b\u8bd5\u3002\u521b\u5efa\u7528\u6237\u3001\u767b\u5f55\u6216\u66f4\u65b0\u914d\u7f6e\u6587\u4ef6\u90fd\u5e94\u8be5\u662f\u6d4b\u8bd5\u5957\u4ef6\u7684\u4e00\u90e8\u5206\u3002\u901a\u8fc7\u8fd9\u79cd\u65b9\u5f0f\uff0c\u60a8\u5c06\u786e\u4fe1\u60a8\u7684\u7aef\u70b9\u80fd\u591f\u5f88\u597d\u5730\u76f8\u4e92\u534f\u4f5c\uff0c\u5e76\u4e14\u6240\u6709\u4e00\u5207\u4f5c\u4e3a\u4e00\u4e2a\u6574\u4f53\u90fd\u80fd\u591f\u6b63\u5e38\u8fd0\u884c\u3002<\/p>\n<p><strong>\u90e8\u7f72\u60a8\u7684API<\/strong><\/p>\n<p><strong>\u5982\u4f55\u6258\u7ba1 Node.js API<\/strong><\/p>\n<p>\u6839\u636e\u60a8\u7684\u9700\u6c42\u548c\u60a8\u6709\u591a\u5c11\u94b1\uff0c\u60a8\u53ef\u4ee5\u5728\u6258\u7ba1 Node.js API \u65f6\u4f7f\u7528\u4ee5\u4e0b\u5176\u4e2d\u4e00\u79cd\uff1aPaaS \u6216\u5e73\u53f0\u5373\u670d\u52a1\uff1a\u8fd9\u5305\u62ec Heroku\u3001DigitalOcean \u548c AWS Elastic Beanstalk\u3002\u6240\u6709\u8fd9\u4e9b\u670d\u52a1\u90fd\u63d0\u4f9b\u4e86\u4e00\u4e2a\u6258\u7ba1\u73af\u5883\u6765\u90e8\u7f72 API\u3002 IaaS\uff08\u5373\u57fa\u7840\u8bbe\u65bd\u5373\u670d\u52a1\uff09\u6d89\u53ca AWS EC2\u3001Google Compute Engine \u548c DigitalOcean Droplets \u7b49\u670d\u52a1\uff0c\u53ef\u8ba9\u60a8\u5728\u865a\u62df\u673a\u4e0a\u90e8\u7f72 API\u3002<br \/> \u5c06\u901a\u8fc7 AWS Lambda\u3001Google Cloud Functions \u548c Azure Functions \u7b49\u670d\u52a1\u63d0\u4f9b\u65e0\u670d\u52a1\u5668\u654f\u6377\u6027\uff0c\u4ece\u800c\u4fc3\u8fdb API \u90e8\u7f72\u3002<br \/> \u4e00\u65b9\u9762\u8003\u8651\u60a8\u7684\u6240\u6709 API \u9700\u6c42\u548c\u8981\u6c42\uff0c\u53e6\u4e00\u65b9\u9762\u8003\u8651\u56e2\u961f\u7684\u4e13\u4e1a\u77e5\u8bc6\u548c\u8d44\u6e90\u4e4b\u95f4\u7684\u6700\u4f73\u5339\u914d\uff0c\u7136\u540e\u9009\u62e9\u5408\u9002\u7684\u6258\u7ba1\u9009\u9879\u3002<\/p>\n<p><strong>\u901a\u8fc7\u96c6\u7fa4\u548c\u8d1f\u8f7d\u5747\u8861\u6269\u5c55\u60a8\u7684 API<\/strong><\/p>\n<p>\u968f\u7740\u60a8\u7684 API \u8d8a\u6765\u8d8a\u53d7\u6b22\u8fce\u548c\u4f7f\u7528\uff0c\u6269\u5c55\u6027\u6210\u4e3a\u4e00\u4e2a\u70ed\u5207\u5173\u6ce8\u7684\u95ee\u9898\u3002\u4f7f\u7528 Node.js \u4e2d\u5185\u7f6e\u7684\u96c6\u7fa4\u6a21\u5757\uff0c\u521b\u5efa\u591a\u4e2a\u53ef\u4ee5\u5e76\u53d1\u5904\u7406\u4f20\u5165\u8bf7\u6c42\u7684\u5de5\u4f5c\u8fdb\u7a0b\u3002<br \/> \u4e3a\u4f20\u5165\u8bf7\u6c42\u5b9e\u73b0\u8d1f\u8f7d\u5e73\u8861\uff0c\u5c06\u8c03\u7528\u5206\u53d1\u5230 API \u7684\u591a\u4e2a\u5b9e\u4f8b\u3002\u8d1f\u8f7d\u5747\u8861\u5668\u53ef\u4ee5\u4f7f\u7528 Nginx \u548c HAProxy \u6765\u5b8c\u6210\u3002<\/p>\n<p><strong>API \u8bbe\u8ba1\u7684\u6700\u4f73\u5b9e\u8df5<\/strong><\/p>\n<p>\u9075\u5faa\u8fd9\u4e9b\u6700\u4f73\u5b9e\u8df5\uff0c\u4f7f\u7528 Node.js \u5f00\u53d1\u4e00\u7ec4\u6709\u6548\u7684 RESTful API\uff1a<\/p>\n<p>\u6784\u5efa\u4e00\u4e2a\u7b80\u5355\u4e14\u4e00\u81f4\u7684 API\u3002\u8fd9\u610f\u5473\u7740\u4f7f\u7528\u975e\u5e38\u5177\u6709\u63cf\u8ff0\u6027\u5e76\u9075\u5faa\u4e00\u81f4\u7684\u547d\u540d\u7ea6\u5b9a\u7684\u7aef\u70b9\u540d\u79f0\u3002<\/p>\n<p>\u786e\u4fdd\u4f7f\u7528\u6b63\u786e\u7684 HTTP \u65b9\u6cd5\u3002\u5982\u679c\u60a8\u786e\u4fdd HTTP \u65b9\u6cd5\u6620\u5c04\u5230\u5176\u76f8\u5e94\u7684 CRUD \u64cd\u4f5c\uff0c\u60a8\u53ef\u4ee5\u4f7f\u60a8\u7684 API \u76f4\u89c2\u4e14\u6613\u4e8e\u5176\u4ed6\u4eba\u4f7f\u7528\u3002<br \/> \u8f93\u5165\u9a8c\u8bc1\u548c\u6e05\u7406\uff1a\u5728\u5c06\u4f20\u5165\u6570\u636e\u653e\u5165 API \u4e4b\u524d\u5bf9\u5176\u8fdb\u884c\u9a8c\u8bc1\u548c\u6e05\u7406\u3002<br \/> \u4f18\u96c5\u5730\u5904\u7406\u9519\u8bef\uff1a\u4f7f\u7528\u9002\u5f53\u7684 HTTP \u72b6\u6001\u4ee3\u7801\u4ee5\u6709\u610f\u4e49\u7684\u9519\u8bef\u6d88\u606f\u54cd\u5e94\u8fdb\u884c\u54cd\u5e94\uff0c\u5e76\u8bb0\u5f55\u8fd9\u4e9b\u9519\u8bef\u4ee5\u8fdb\u884c\u8c03\u8bd5\u548c\u76d1\u63a7\u3002<\/p>\n<p>\u5b9e\u73b0\u8eab\u4efd\u9a8c\u8bc1\u548c\u6388\u6743\u3002\u4f7f\u7528\u5b89\u5168\u7684\u8eab\u4efd\u9a8c\u8bc1\u65b9\u6cd5\uff0c\u4f8b\u5982 JWT\uff0c\u5e76\u5b9e\u65bd\u6388\u6743\u6765\u89c4\u8303 API \u4efb\u4f55\u8d44\u6e90\u7684\u8bbf\u95ee\u63a7\u5236\u3002<br \/> \u8bb0\u5f55\u60a8\u7684 API\uff1a\u63d0\u4f9b\u5168\u9762\u7684\u6587\u6863\uff0c\u5176\u4e2d\u5305\u542b\u7aef\u70b9\u7684\u63cf\u8ff0\u3001\u8bf7\u6c42\u548c\u54cd\u5e94\u7684\u793a\u4f8b\u4ee5\u53ca\u8eab\u4efd\u9a8c\u8bc1\u8be6\u7ec6\u4fe1\u606f\u3002<br \/> \u6d4b\u8bd5\u60a8\u7684 API\uff1a\u7ecf\u8fc7\u6d4b\u8bd5\u7684 API \u4e00\u5b9a\u80fd\u6309\u9884\u671f\u5de5\u4f5c\uff0c\u540c\u65f6\u6355\u83b7\u5f00\u53d1\u8fc7\u7a0b\u65e9\u671f\u53d1\u751f\u7684\u4efb\u4f55\u56de\u5f52\u3002\u60a8\u53ef\u4ee5\u901a\u8fc7\u5355\u5143\u6d4b\u8bd5\u548c\u96c6\u6210\u6d4b\u8bd5\u6765\u505a\u5230\u8fd9\u4e00\u70b9\u3002<br \/> \u76d1\u63a7\u60a8\u7684\u811a\u672c\uff1a\u53ef\u89c2\u5bdf\u6027\u662f\u4e86\u89e3 API \u4e2d\u7684\u6027\u80fd\u3001\u4f7f\u7528\u60c5\u51b5\u548c\u9519\u8bef\u7684\u5173\u952e\uff0c\u53ef\u4ee5\u6700\u7ec8\u5feb\u901f\u89e3\u51b3\u95ee\u9898\u3002<\/p>\n<p>\u901a\u8fc7\u8fd9\u6837\u505a\uff0c\u7f16\u5199\u4e00\u4e2a\u6709\u6548\u7684\u3001\u53ef\u6269\u5c55\u7684\u3001\u53ef\u7ef4\u62a4\u7684 RESTful API \u6765\u6ee1\u8db3\u60a8\u7684\u5ba2\u6237\u548c\u7528\u6237\u7684\u9700\u6c42\u3002<\/p>\n<p><strong>\u603b\u7ed3<\/strong><\/p>\n<p>\u5e0c\u671b\u5bf9\u73b0\u4ee3 Web \u5e94\u7528\u7a0b\u5e8f\u8fdb\u884c\u6709\u6548\u7f16\u7a0b\u7684\u5f00\u53d1\u4eba\u5458\u5fc5\u987b\u5b66\u4e60\u5982\u4f55\u4f7f\u7528 Node.js \u6700\u597d\u5730\u8bbe\u8ba1 API\u3002\u4e86\u89e3\u6307\u5bfc RESTful API \u8bbe\u8ba1\u7684\u539f\u5219\u4ee5\u53ca Node.js \u7684\u5f3a\u5927\u529f\u80fd\uff0c\u4f7f\u5f00\u53d1\u4eba\u5458\u80fd\u591f\u521b\u5efa\u9ad8\u5ea6\u53ef\u6269\u5c55\u3001\u53ef\u7ef4\u62a4\u4e14\u7528\u6237\u53cb\u597d\u7684 API\u3002<\/p>\n<p>\u5bf9\u4e8e\u5728\u6d77\u5f97\u62c9\u5df4\u5bfb\u627e Java \u5f00\u53d1\u8bfe\u7a0b\u7684\u5b66\u751f\u6765\u8bf4\uff0c\u8fd9\u662f\u4ed6\u4eec\u53ef\u4ee5\u8ffd\u6c42\u7684\u975e\u5e38\u91cd\u8981\u7684\u6280\u80fd\u4e4b\u4e00\uff0c\u8fd9\u4e3a\u5927\u91cf\u7684\u804c\u4e1a\u9009\u62e9\u6253\u5f00\u4e86\u5927\u95e8\u3002\u9274\u4e8e\u5e02\u573a\u5bf9\u719f\u7ec3 Node.js \u5f00\u53d1\u4eba\u5458\u7684\u9700\u6c42\u4e0d\u65ad\u589e\u52a0\uff0c\u8bbe\u8ba1\u548c\u6709\u6548\u63d0\u51fa RESTful API \u7684\u80fd\u529b\u5c06\u6210\u4e3a\u5c31\u4e1a\u5e02\u573a\u7684\u5173\u952e\u5dee\u5f02\u5316\u56e0\u7d20\u3002<\/p>\n<p>\u901a\u8fc7\u62e5\u62b1 API \u8bbe\u8ba1\u7684\u5de5\u827a\u548c\u827a\u672f\u5e76\u4e0d\u65ad\u7ec3\u4e60\u4ee5\u8fbe\u5230\u7cbe\u901a\uff0c\u5f00\u53d1\u4eba\u5458\u53ef\u4ee5\u5e26\u6765\u521b\u9020\u6027\u7684\u89e3\u51b3\u65b9\u6848\uff0c\u7ee7\u7eed\u6311\u6218\u7f51\u7edc\u7684\u6781\u9650\u3002\u5728\u6280\u200b\u200b\u672f\u4ece\u65e5\u51fa\u5230\u65e5\u843d\u7684\u53d8\u5316\u4e2d\uff0c\u4f7f\u7528 Node.js \u8fdb\u884c\u6b63\u786e\u7684 API \u8bbe\u8ba1\u5c06\u5728\u672a\u6765\u7684\u53ef\u6269\u5c55\u548c\u54cd\u5e94\u5f0f\u5e94\u7528\u7a0b\u5e8f\u5f00\u53d1\u4e2d\u53d1\u6325\u5de8\u5927\u7684\u57fa\u7840\u4f5c\u7528\u3002<\/p>\n<p>\u6587\u4e2d\u5173\u4e8e\u7684\u77e5\u8bc6\u4ecb\u7ecd\uff0c\u5e0c\u671b\u5bf9\u4f60\u7684\u5b66\u4e60\u6709\u6240\u5e2e\u52a9\uff01\u82e5\u662f\u53d7\u76ca\u532a\u6d45\uff0c\u90a3\u5c31\u52a8\u52a8\u9f20\u6807\u6536\u85cf\u8fd9\u7bc7\u300aAPI \u8bbe\u8ba1\u7684\u827a\u672f\uff1a\u4f7f\u7528 Nodejs \u521b\u5efa\u6709\u6548\u7684 RESTful API\u300b\u6587\u7ae0\u5427\uff0c\u4e5f\u53ef\u5173\u6ce8\u516c\u4f17\u53f7\u4e86\u89e3\u76f8\u5173\u6280\u672f\u6587\u7ae0\u3002<\/p>\n<p>      \u7248\u672c\u58f0\u660e \u672c\u6587\u8f6c\u8f7d\u4e8e\uff1adev.to \u5982\u6709\u4fb5\u72af\uff0c\u8bf7\u8054\u7cfb\u5220\u9664<\/p>\n","protected":false},"excerpt":{"rendered":"<p>API \u8bbe\u8ba1\u7684\u827a\u672f\uff1a\u4f7f\u7528 Nod&#46;&#46;&#46;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4925],"tags":[],"class_list":["post-205332","post","type-post","status-publish","format-standard","hentry","category-4925"],"_links":{"self":[{"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/posts\/205332","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/comments?post=205332"}],"version-history":[{"count":0,"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/posts\/205332\/revisions"}],"wp:attachment":[{"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/media?parent=205332"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/categories?post=205332"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/tags?post=205332"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}