{"id":1367,"date":"2020-08-28T10:16:11","date_gmt":"2020-08-28T02:16:11","guid":{"rendered":"http:\/\/hesiwei.cn\/?p=1367"},"modified":"2020-08-28T10:16:11","modified_gmt":"2020-08-28T02:16:11","slug":"rest-api-%e8%ae%be%e8%ae%a1%e6%9c%80%e4%bd%b3%e5%ae%9e%e8%b7%b5","status":"publish","type":"post","link":"https:\/\/hesiwei.cn\/?p=1367","title":{"rendered":"REST API \u8bbe\u8ba1\u6700\u4f73\u5b9e\u8df5"},"content":{"rendered":"<p><a name=\"X7rUj\"><\/a><\/p>\n<h2>\u4e00 \u524d\u8a00<\/h2>\n<p>\u4f5c\u4e3a\u4e00\u540d\u540e\u7aef\u7a0b\u5e8f\u5458\uff0c\u7167\u7740\u4ea7\u54c1\u9700\u6c42\u8bbe\u8ba1\u597d\u4e86\u6a21\u578b\uff0c\u8bbe\u8ba1\u597d\u4e86\u5173\u8054\u5173\u7cfb\uff0c\u8bbe\u8ba1API\u65f6\u5019\u95ee\u9898\u6765\u4e86\uff1a\u4e00\u65e6 API \u8fdb\u5165\u524d\u7aef APP \u4ee3\u7801\uff0c\u6216\u8005\u662f\u88ab\u4f60\u7684\u987e\u5ba2\u5e7f\u6cdb\u4f7f\u7528\u7684\u8bdd\uff0c\u518d\u6765\u5927\u6539\u5c31\u975e\u5e38\u9ebb\u70e6\u4e86\u3002\u6bd4\u5982\u8bf4\uff0c\u5982\u679c APP \u7248\u672c 1.0 \u7528\u4e86\u4e00\u4e2a\u63a5\u53e3 A\uff0c\u8fd9\u4e2a\u63a5\u53e3 A \u5982\u679c\u8981\u8fdb\u884c\u5927\u6539\uff0c\u90a3\u4e48\u5fc5\u987b\u5c06 A \u7ef4\u6301\u81f3\u6240\u6709\u7528\u6237\u5347\u7ea7\u8fc7 APP 1.0 \u540e\u3002\u90a3\u4e48\u600e\u4e48\u6837\u907f\u514d API \u53d1\u5e03\u4e4b\u540e\u5927\u6539\u5462\uff1f\u6709\u6ca1\u6709\u4e00\u4e9b\u63d0\u524d\u53ef\u4ee5\u6ce8\u610f\u5230\u7684\u8bbe\u8ba1\u51c6\u5219\u53ef\u4ee5\u5e2e\u6211\u4eec\u907f\u5f00 API \u8bbe\u8ba1\u4e2d\u7684\u5404\u79cd\u5751\uff1f<\/p>\n<p><a name=\"Rol1K\"><\/a><\/p>\n<h2>\u4e8c REST API \u662f\u4ec0\u4e48<\/h2>\n<p>REST API \u6709\u4e00\u5957 API \u8bbe\u8ba1\u7684\u51c6\u5219\uff0c\u5b83\u89c4\u8303\u4e86 API \u8bbe\u8ba1\u7684\u6846\u67b6\uff0c\u4f7f\u5f97\u670d\u52a1\u95f4\u3001\u7a0b\u5e8f\u5458\u4e4b\u95f4\u6709\u4e00\u4e2a\u901a\u7528\u7684\u6c9f\u901a\u8bed\u8a00\u3002<br \/>\n<a name=\"J3Vsh\"><\/a><\/p>\n<h2>\u4e09 REST API \u5185\u5177\u4f53\u89c4\u5b9a\u4e86\u4ec0\u4e48<\/h2>\n<p>REST API \u89c4\u8303\u4e86 API \u8bbe\u8ba1\u7684\u4e24\u5927\u6838\u5fc3\u539f\u5219<\/p>\n<ol>\n<li>API\u5e94\u8be5\u4f5c\u7528\u4e8e Resource\uff08\u8d44\u6e90\uff09\u4e0a<\/li>\n<li>\u5bf9\u8d44\u6e90\u7684\u64cd\u4f5c\u5e94\u4f7f\u7528\u5bf9\u5e94\u8bed\u4e49\u7684\u51e0\u79cd\u64cd\u4f5c\uff0c\u5305\u62ec\uff1a GET, POST, PUT, PATCH, DELETE<br \/>\n<a name=\"D0iRq\"><\/a><\/li>\n<\/ol>\n<h4>\u4ec0\u4e48\u662fResource\uff08\u8d44\u6e90\uff09<\/h4>\n<p>\u8fd9\u91cc\u7684\u8d44\u6e90\u662f\u53ef\u64cd\u4f5c\u7684\u903b\u8f91\u5bf9\u8c61\uff0c\u5141\u8bb8\u8c03\u7528\u8005\u8fdb\u884c\u64cd\u4f5c\uff0c\u6bd4\u5982\u7528\u6237\u6ce8\u518c\uff0c\u90a3\u4e48 API \u7c7b\u4f3c\u4e8e<code>POST \/users<\/code>\uff0c\u8d44\u6e90\u5373\u4e3a <code>users<\/code>\u3002\u5728\u5f88\u591a\u60c5\u51b5\u4e0b\uff0cAPI \u4e2d\u7684\u8d44\u6e90\u4e0e\u4f60\u7684\u6570\u636e\u6a21\u578b\u662f\u4e00\u4e00\u5bf9\u5e94\u7684\u3002\u5f53\u7136\u4e5f\u6709\u4f8b\u5916\u60c5\u51b5\uff0c\u6bd4\u5982\u8bf4\u4f60\u7684\u6570\u636e\u5e93\u4e2d\u5b58\u6709\u7528\u6237\uff0c\u4f46\u662f\u4f60\u73b0\u5728\u60f3\u8981\u8ba9\u8c03\u7528\u8005\u53ef\u4ee5\u521b\u5efa\u201c\u7ba1\u7406\u5458\u201d\uff0c\u90a3\u4e48 API \u53ef\u80fd\u662f<code>POST \/admins<\/code>\u8868\u4e2d\u5e76\u6ca1\u6709 <code>admins<\/code> \u8fd9\u4e2a\u8868\uff0c\u53ef\u80fd admin \u662f Users \u8868\u4e2d\u7684\u4e00\u4e2a\u5c5e\u6027\uff0c\u6bd4\u5982 <code>role=admin<\/code>\u3002<br \/>REST API\u4e2d\u7684\u8d44\u6e90\u4e00\u5b9a\u9700\u8981\u662f\u540d\u8bcd\uff0c\u5373\u4e00\u5b9a\u662f\u4e00\u4e2a\u5b9e\u5728\u5b58\u5728\u7684\u6982\u5ff5\uff0c\u6bd4\u5982 <code>\u7528\u6237<\/code>, <code>\u5e10\u53f7<\/code>, <code>\u8f66\u7968<\/code>\u7b49\uff0c\u6216\u4e00\u4e2a\u62bd\u8c61\u7684\u6982\u5ff5\uff0c\u6bd4\u5982 <code>\u6743\u9650<\/code> \u7b49\u3002<br \/>\u5982\u679c\u4f60\u9700\u8981\u63d0\u4f9b\u4e00\u4e2a\u521b\u5efa\u67d0\u79cd\u8d44\u6e90\u7684API\u63a5\u53e3\uff0c<code>POST \/indexes<\/code>\uff0c<code>POST \/accounts<\/code>\uff0c<code>POST \/docs<\/code>\u7b49\u7b49\u3002<br \/>\u5bf9\u4e8e\u8d44\u6e90\u7684\u547d\u540d\uff0c\u5efa\u8bae\u7edf\u4e00\u547d\u540d\u4e3a\u4e3a\u82f1\u6587\u7684\u590d\u6570\u3002\u6bd4\u5982\u8bf4 <code>users<\/code> \u800c\u4e0d\u662f <code>user<\/code>\u3002\u66f4\u91cd\u8981\u7684\u662f\u4fdd\u6301\u4e00\u81f4\u6027\uff0c\u5728\u6240\u6709\u5730\u65b9\u7528\u4e00\u6837\u7684\u590d\u6570\u3002<br \/>\n<a name=\"G9tBX\"><\/a><\/p>\n<h4>\u4ec0\u4e48\u662f\u64cd\u4f5c<\/h4>\n<p>\u4e00\u65e6\u5b9a\u4e49\u4e86\u8d44\u6e90\uff0c\u63a5\u4e0b\u6765\u9700\u8981\u5b9a\u4e49\u5141\u8bb8\u8c03\u7528\u8005\u5728\u8fd9\u4e9b\u8d44\u6e90\u4e0a\u505a\u4ec0\u4e48\u64cd\u4f5c\u3002<br \/>\u6bd4\u5982\u8bf4\uff0c\u4ee5\u62a2\u8f66\u7968\u4e3a\u4f8b\uff0c\u6211\u4eec\u53ef\u80fd\u5141\u8bb8\u8c03\u7528\u8005\u8fdb\u884c\u4ee5\u4e0b\u64cd\u4f5c<\/p>\n<ul>\n<li><code>GET \/tickets<\/code> &#8211; \u5217\u51fa\u6240\u6709\u8f66\u7968<\/li>\n<li><code>GET \/tickets\/9839<\/code> &#8211; \u5217\u51fa id \u4e3a 9839 \u8fd9\u5f20\u8f66\u7968\u7684\u4fe1\u606f<\/li>\n<li><code>POST \/tickets<\/code> &#8211; \u521b\u5efa\u4e00\u5f20\u8f66\u7968<\/li>\n<li><code>PUT \/tickets\/9839<\/code> &#8211; \u66f4\u65b0 9839 \u8fd9\u5f20\u8f66\u7968\u7684\u4fe1\u606f<\/li>\n<li><code>PATCH \/tickets\/9839<\/code> &#8211; \u90e8\u5206\u4fee\u6539 983 \u8fd9\u5f20\u8f66\u7968\u7684\u4fe1\u606f\uff0c\u6bd4\u5982\u53ea\u4fee\u6539\u8f66\u7968\u4ef7\u683c<\/li>\n<li><code>DELETE \/tickets\/9839<\/code> &#8211; \u5220\u6389 9839 \u8fd9\u5f20\u8f66\u7968<\/li>\n<\/ul>\n<p>\u4ee5\u4e0a\u53ef\u4ee5\u603b\u7ed3\u51fa\u6765REST\u7684\u5927\u81f4\u8bbe\u8ba1\u601d\u8def\u4e86\u3002\u5b83\u7531\u4e24\u90e8\u5206\u7ec4\u6210\uff0c\u7b2c\u4e00\u90e8\u5206\u662f <code>\u64cd\u4f5c<\/code>\uff0c\u7b2c\u4e8c\u90e8\u5206\u662f\u53ef\u64cd\u4f5c\u7684 <code>\u8d44\u6e90<\/code>\u3002\u6bd4\u5982\u4e0a\u6587\u4e2d\u7684 <code>GET \/tickets<\/code>\uff0c\u64cd\u4f5c\u662f GET\uff0c\u53ef\u64cd\u4f5c\u7684\u8d44\u6e90\u662f\u8f66\u7968\u3002<br \/>\u5982\u679c\u4e25\u683c\u9075\u5faa\u4e86REST\u7684\u8bbe\u8ba1\u51c6\u5219\uff0c\u8c03\u7528\u8005\u4e5f\u4e86\u89e3 REST \u7684\u51c6\u5219\u7684\u8bdd\uff0c\u90a3\u4e48\u5bf9\u4e8e\u5f88\u591a API \u8c03\u7528\uff0c\u4e0d\u7528\u518d\u53c2\u8003\u4e92\u76f8\u5199\u7684\u6587\u6863\u4e86\u3002\u5982\u679c\u9700\u8981\u8c03\u7528\u4e00\u5f20\u8f66\u7968\u7684\u4fe1\u606f\uff0c\u8c03\u7528\u8005\u81ea\u7136\u4f1a\u77e5\u9053\u5e94\u8be5\u7528GET\u53bb\u67e5\u770b\u4e00\u4e2a\u8f66\u7968\u8d44\u6e90\u7684\u4fe1\u606f\uff0c\u5373 <code>GET \/tickets\/:ticketId<\/code>\uff0c\u8fd9\u6837\u5c31\u6781\u5927\u964d\u4f4e\u4e86\u6c9f\u901a\u6210\u672c\u548c\u51fa\u9519\u6210\u672c\uff0c\u63d0\u5347\u6548\u7387\u3002<br \/>\n<a name=\"pw4FA\"><\/a><\/p>\n<h4>\u5982\u4f55\u5728 API \u4e2d\u8868\u793a\u5b9e\u4f53\uff08\u6570\u636e\u5e93\u8868\uff09\u95f4\u5173\u7cfb<\/h4>\n<p>\u5728\u540e\u7aef\u8bbe\u8ba1\u4e2d\uff0c\u6709\u7684\u8d44\u6e90\u903b\u8f91\u4e0a\u65e0\u6cd5\u72ec\u7acb\u5b58\u5728\u3002\u6bd4\u5982\u8bf4\uff0c\u6709\u7d22\u5f15\u5b58\u5728\uff0c\u7528<code>GET \/indexes\/index_abc\/docs\/1<\/code>\u6765\u8868\u8fbe\u83b7\u53d6\u7d22\u5f15 <code>index_abc<\/code> \u4e2d\u7f16\u53f7\u4e3a <code>1<\/code> \u7684\u6587\u6863\u3002\u56e0\u6b64\uff0c\u5bf9\u4e8e\u6240\u6709\u8d44\u6e90\u9700\u8981\u4f9d\u8d56\u4e8e\u53e6\u4e00\u4e2a\u8d44\u6e90\u5b58\u5728\u65f6\uff0c\u6211\u4eec\u5c31\u6309\u987a\u5e8f\u5728\u7aef\u70b9\u4e2d\u5c06\u8d44\u6e90\u5217\u51fa\u6765\u3002\u7d22\u5f15\u548c\u6587\u6863\u7684\u5173\u7cfb\uff0c\u53ef\u4ee5\u6709\u4ee5\u4e0b\u63a5\u53e3<\/p>\n<ul>\n<li><code>GET \/indexes\/index_abc\/docs\/1<\/code> &#8211; \u83b7\u53d6index id\u4e3a <code>index_abc<\/code> \u4e0b\u7684id\u4e3a <code>1<\/code> \u7684\u6587\u6863<\/li>\n<li><code>GET \/indexes\/index_abc\/docs<\/code> &#8211; \u83b7\u53d6index id\u4e3a <code>index_abc<\/code> \u4e0b\u7684\u6240\u6709\u6587\u6863<\/li>\n<li><code>POST \/indexes\/index_abc\/docs<\/code> &#8211; \u5728index id\u4e3a <code>index_abc<\/code> \u7684\u7d22\u5f15\u4e2d\uff0c\u6dfb\u52a0\u6587\u6863 &#8230;<\/li>\n<\/ul>\n<p>\u5982\u679c\u4e00\u4e2a\u8d44\u6e90\u53ef\u4ee5\u72ec\u7acb\u4e8e\u53e6\u4e00\u4e2a\u8d44\u6e90\u5b58\u5728\uff0c\u90a3\u4e48\u53ef\u4ee5\u8003\u8651\u76f4\u63a5\u63d0\u4f9b\u5b50\u7aef\u70b9\u3002\u6bd4\u5982\u8bf4\uff0c\u5982\u679c\u4e00\u4e2a\u5ba0\u7269\u5e97\u4e3b\u4eba\u548c\u5ba0\u7269\u4fe1\u606f\u5206\u522b\u90fd\u5e38\u5e38\u88ab\u540c\u65f6\u8c03\u7528\uff0c\u90a3\u4e48\u53ef\u4ee5\u8003\u8651<\/p>\n<blockquote><p>\n  GET \/owners\/ \u00a0&#8211; \u83b7\u53d6\u6240\u6709\u4e3b\u4eba\u4fe1\u606f<br \/>\n  GET \/owners\/1\/pets\/ \u83b7\u53d6 id \u4e3a 1 \u7684\u4e3b\u4eba\u7684\u6240\u6709\u5ba0\u7269<\/p>\n<p>  GET \/pets\/ &#8211; \u83b7\u53d6\u6240\u6709\u5ba0\u7269\u4fe1\u606f\uff08\u5ba0\u7269\u5e97\u6240\u6709\u5ba0\u7269\uff09<\/p>\n<p>  GET \/pets\/13 &#8211; \u76f4\u63a5\u83b7\u53d6 id \u4e3a 13 \u7684\u5ba0\u7269\n<\/p><\/blockquote>\n<p><a name=\"6M2mN\"><\/a><\/p>\n<h4>REST API\u4e2d\u5982\u4f55\u8868\u793a\u4e00\u4e2a\u52a8\u4f5c<\/h4>\n<p>\u6709\u65f6\u5019\u8868\u8fbe\u4e00\u4e9b\u63a5\u53e3\u65f6\uff0c\u4f1a\u53d1\u73b0REST\u7684\u51c6\u5219\u5f88\u96be\u76f4\u63a5\u5e94\u7528\u3002\u6bd4\u5982\u7528\u6237\u767b\u5f55<code>POST \/users\/signin<\/code>\uff0c\u8fd9\u91cc\u7684 <code>signin<\/code>\u662f\u4e2a\u52a8\u8bcd\u3002\u91c7\u7528REST\u51c6\u5219\u65f6\u53ef\u4ee5\u8003\u8651\u6709\u4e09\u4e2a\u9009\u62e9<\/p>\n<ol>\n<li>\u4e25\u683c\u5730\u9075\u5faa REST \u539f\u5219\uff0c\u627e\u4e00\u4e2a\u66ff\u4ee3\u52a8\u8bcd\u7684\u540d\u8bcd\u3002 <code>signin<\/code> \u53ef\u4ee5\u66ff\u6362\u4e3a<code>login<\/code>\u3002\u6216\u8005\uff0c\u4ee5 token \u5bc6\u94a5\u7684\u65b9\u5f0f\u767b\u5f55\u7684\u8bdd\uff0c\u53ef\u4ee5\u6539\u4e3a <code>POST \/users\/token<\/code>\uff0c\u521b\u5efa\u4e00\u4e2a user token(\u4e5f\u5c31\u662f\u767b\u5f55\u4e86)<\/li>\n<li>\u5728\u67d0\u4e9b\u5b9e\u5728\u56f0\u96be\u7684\u5730\u65b9\uff0c\u653e\u5f03\u4e25\u683c\u7684REST\u539f\u5219<\/li>\n<li>\u53c2\u8003\u4e00\u4e9b\u6210\u529f\u7684 REST API \u5e76\u5bfb\u627e\u7c7b\u4f3c\u7684 API\uff0c\u53c2\u8003\u4ed6\u4eec\u7684\u547d\u540d\u8bbe\u8ba1\uff0c\u5982 <a class=\"wp-editor-md-post-content-link\" href=\"https:\/\/github.com\/microsoft\/api-guidelines\/blob\/vNext\/Guidelines.md\">github<\/a> \u7684 API\uff0c\u8f83\u4e3a\u89c4\u8303\uff0c\u8986\u76d6\u4e86\u5f88\u591a API \u8c03\u7528\u7684\u60c5\u666f\uff0c\u53ef\u4ee5\u627e\u5230\u4e2a\u7c7b\u4f3c\u7684\u547d\u540d\u53c2\u8003\u3002<\/li>\n<\/ol>\n<p>\u6bd4\u5982\u8bf4\uff0c\u5728 github \u4e0a\uff0c\u5982\u679c\u8ba9\u4f60\u6765\u8bbe\u8ba1\u52a0\u661f\u8fd9\u4e2a\u64cd\u4f5c\uff0c\u4f60\u4f1a\u628a\u7aef\u70b9\u88ab\u8bbe\u8ba1\u6210\u4ec0\u4e48\u6837\uff1f<br \/>Github\u628a\u52a0\u661f\u7aef\u70b9\u8bbe\u8ba1\u4e3a <code>PUT \/gists\/:id\/star<\/code>\uff0c\u628a\u53d6\u6d88\u52a0\u661f\u8bbe\u8ba1\u4e3a <code>DELETE \/gitsts\/:id\/star<\/code>\u3002\u8fd9\u6837\u5c31\u5b8c\u7f8e\u5730\u9075\u5faa\u4e86 REST \u540d\u8bcd\u4f5c\u4e3a\u8d44\u6e90\u7684\u51c6\u5219\uff0c\u628a\u52a8\u8bcd&#8221;\u52a0\u661f&#8221;\u5b8c\u7f8e\u5730\u7528 <code>PUT\/DELETE<\/code> \u4e24\u4e2a\u64cd\u4f5c\u6e05\u6670\u5730\u8868\u8fbe\u51fa\u6765\u3002<br \/>\n<a name=\"e3coz\"><\/a><\/p>\n<h2>REST API \u8bbe\u8ba1\u5e38\u89c1\u95ee\u9898\u548c\u5efa\u8bae<\/h2>\n<p><a name=\"Hubat\"><\/a><\/p>\n<h4>\u5982\u4f55\u533a\u5206\u7248\u672c<\/h4>\n<p>\u6bd4\u5982\u8bf4\uff0c\u5982\u679c\u5728\u5927\u81f4\u5c06 v1 \u5f00\u53d1\u5b8c\u6bd5\u540e\uff0cv1 \u524d\u7f00\u7684 API \u5c31\u5e94\u8be5\u7a33\u5b9a\u4e0b\u6765\uff0c\u6240\u6709\u7684\u6539\u52a8\u8fdb\u5165 v2\u3002\u540c\u65f6\u5f00\u59cb\u901a\u77e5\u6240\u6709\u4f7f\u7528 v1 \u7684\u7528\u6237\uff0c\u5e2e\u52a9\u4ed6\u4eec\u5e73\u6ed1\u8fc1\u79fb\u5230 v2\u3002\u5e26\u6709\u7248\u672c\u524d\u7f00\u7684 API \u793a\u4f8b\u5982\u4e0b<\/p>\n<blockquote><p>\n  GET \/v1\/indexes\/<br \/>\n  GET \/v1\/indexes\/abc\/<br \/>\n  POST \/v1\/indexes\/\n<\/p><\/blockquote>\n<p>\u4e5f\u53ef\u4ee5\u7528\u5b50\u57df\u540d\u8868\u793a<\/p>\n<blockquote><p>\n  <a class=\"wp-editor-md-post-content-link\" href=\"http:\/\/api.example.com\/v1\">http:\/\/api.example.com\/v1<\/a><br \/>\n  <a class=\"wp-editor-md-post-content-link\" href=\"http:\/\/apiv1.example.com\">http:\/\/apiv1.example.com<\/a>\n<\/p><\/blockquote>\n<p>\u6216\u8005\u6dfb\u52a0\u81ea\u5b9a\u4e49\u8bf7\u6c42\u5934\u90e8<\/p>\n<blockquote><p>\n  Accept-version: v1<br \/>\n  Accept-version: v2\n<\/p><\/blockquote>\n<p><a name=\"EH7js\"><\/a><\/p>\n<h4>\u8fc7\u6ee4\u3001\u6392\u5e8f\u3001\u5b57\u6bb5\u9009\u62e9\u548c\u5206\u9875<\/h4>\n<p>\u8fc7\u6ee4\uff1a\u4e3a\u6240\u6709\u5b57\u6bb5\u6216\u8005\u67e5\u8be2\u8bed\u53e5\u63d0\u4f9b\u72ec\u7acb\u7684\u67e5\u8be2\u53c2\u6570\u3002<\/p>\n<blockquote><p>\n  GET \/cars?color=red \u8fd4\u56de\u7ea2\u8272\u8f66\u7684\u5217\u8868<br \/>\n  GET \/cars?seats&lt;=2 \u8fd4\u56de\u4e24\u5ea7\u8f66\u7684\u5217\u8868\n<\/p><\/blockquote>\n<p>\u6392\u5e8f\uff1a\u5141\u8bb8\u8de8\u8d8a\u591a\u5b57\u6bb5\u7684\u6b63\u5e8f\u6216\u8005\u5012\u5e8f\u6392\u5217\u3002<\/p>\n<blockquote><p>\n  GET \/cars?sort=-manufactorer,+model \u8fd4\u56de\u6392\u5e8f\u7684\u8f66\u8f86\u5217\u8868\n<\/p><\/blockquote>\n<p>\u5b57\u6bb5\u9009\u62e9\uff1a\u53ea\u5217\u51fa\u9700\u8981\u7684\u5b57\u6bb5\u3002\u4e00\u4e9b\u60c5\u51b5\u4e0b\uff0c\u53ea\u9700\u8981\u5728\u5217\u8868\u4e2d\u67e5\u8be2\u51e0\u4e2a\u6709\u6807\u8bc6\u610f\u4e49\u7684\u5b57\u6bb5\uff0c\u5e76\u4e0d\u9700\u8981\u4ece\u670d\u52a1\u7aef\u628a\u6240\u6709\u5b57\u6bb5\u7684\u503c\u90fd\u8bf7\u6c42\u51fa\u6765\uff0c\u56e0\u6b64\u9700\u8981API\u652f\u6301\u9009\u62e9\u67e5\u8be2\u5b57\u6bb5\u7684\u80fd\u529b\u3002\u8fd9\u6837\u4e5f\u53ef\u4ee5\u5728\u4e00\u5b9a\u7a0b\u5ea6\u4e0a\u63d0\u9ad8\u7f51\u7edc\u4f20\u8f93\u7684\u6027\u80fd\u4e0e\u54cd\u5e94\u901f\u5ea6\u3002<\/p>\n<blockquote><p>\n  GET \/cars?fields=manufacturer,model,id,color \u8fd4\u56de\u9700\u8981\u7684\u8f66\u8f86\u4fe1\u606f\u5b57\u6bb5\u7684\u5217\u8868\n<\/p><\/blockquote>\n<p>\u5206\u9875\uff1a\u4f7f\u7528offset\u548climit\u6765\u83b7\u53d6\u56fa\u5b9a\u6570\u91cf\u7684\u8d44\u6e90\u7ed3\u679c\uff0c\u5f53\u5176\u4e2d\u4e00\u4e2a\u53c2\u6570\u6ca1\u6709\u51fa\u73b0\u65f6\uff0c\u5e94\u8be5\u63d0\u4f9b\u5404\u81ea\u7684\u9ed8\u8ba4\u503c\uff0c\u6bd4\u5982\u9ed8\u8ba4\u53d6\u7b2c\u4e00\u9875\uff0c\u6216\u8005\u9ed8\u8ba4\u53d620\u6761\u6570\u636e\u3002<\/p>\n<blockquote><p>\n  GET \/cars?offset=10&amp;limit=5 \u8fd4\u56de\u7b2c10\u9875\u76845\u6761\u8f66\u8f86\u8bb0\u5f55\u5217\u8868<br \/>\n  GET \/cars?&amp;limit=5 \u8fd4\u56de\u524d5\u6761\u8f66\u8f86\u8bb0\u5f55\u5217\u8868<br \/>\n  GET \/cars?&amp;offset=5 \u8fd4\u56de\u7b2c5\u9875\u7684\u8f66\u8f86\u8bb0\u5f55\u5217\u8868\uff08\u9ed8\u8ba4\u5355\u9875\u6570\u91cf\uff09\n<\/p><\/blockquote>\n<p><a name=\"6sVhi\"><\/a><\/p>\n<h4>\u5e94\u8be5\u8fd4\u56de\u4ec0\u4e48<\/h4>\n<p>\u5efa\u8bae REST API \u6c38\u8fdc\u8fd4\u56de JSON \u683c\u5f0f\u7684\u7ed3\u679c\u3002<br \/>\u56e0\u4e3a\u8fd9\u6837\u624d\u80fd\u8fd4\u56de\u6807\u51c6\u7684\u7ed3\u6784\u5316\u6570\u636e\u3002\u6240\u4ee5\uff0c\u670d\u52a1\u5668\u56de\u5e94\u7684 HTTP \u5934\u7684Content-Type\u5c5e\u6027\u8981\u8bbe\u4e3aapplication\/json\u3002\u5ba2\u6237\u7aef\u8bf7\u6c42\u65f6\uff0c\u4e5f\u8981\u660e\u786e\u544a\u8bc9\u670d\u52a1\u5668\uff0c\u53ef\u4ee5\u63a5\u53d7 JSON \u683c\u5f0f\uff0c\u5373\u8bf7\u6c42\u7684 HTTP \u5934\u7684ACCEPT\u5c5e\u6027\u4e5f\u8981\u8bbe\u6210application\/json<br \/>\n<a name=\"sikoZ\"><\/a><\/p>\n<h4>HTTP \u72b6\u6001\u7801<\/h4>\n<ul>\n<li><code>1xx<\/code>\uff1a\u76f8\u5173\u4fe1\u606f<\/li>\n<li><code>2xx<\/code>\uff1a\u64cd\u4f5c\u6210\u529f<\/li>\n<li><code>3xx<\/code>\uff1a\u91cd\u5b9a\u5411<\/li>\n<li><code>4xx<\/code>\uff1a\u5ba2\u6237\u7aef\u9519\u8bef<\/li>\n<li><code>5xx<\/code>\uff1a\u670d\u52a1\u5668\u9519\u8bef<\/li>\n<\/ul>\n<p>\u8fd9\u4e94\u5927\u7c7b\u603b\u5171\u5305\u542b100\u591a\u79cd\u72b6\u6001\u7801\uff0c\u8986\u76d6\u4e86\u7edd\u5927\u90e8\u5206\u53ef\u80fd\u9047\u5230\u7684\u60c5\u51b5\u3002\u6bcf\u4e00\u79cd\u72b6\u6001\u7801\u90fd\u6709\u6807\u51c6\u7684\uff08\u6216\u8005\u7ea6\u5b9a\u7684\uff09\u89e3\u91ca\uff0c\u5ba2\u6237\u7aef\u53ea\u9700\u67e5\u770b\u72b6\u6001\u7801\uff0c\u5c31\u53ef\u4ee5\u5224\u65ad\u51fa\u53d1\u751f\u4e86\u4ec0\u4e48\u60c5\u51b5\uff0c\u6240\u4ee5\u670d\u52a1\u5668\u5e94\u8be5\u8fd4\u56de\u5c3d\u53ef\u80fd\u7cbe\u786e\u7684\u72b6\u6001\u7801\u3002<br \/><strong>2xx \u72b6\u6001\u7801<\/strong><br \/>200\u72b6\u6001\u7801\u8868\u793a\u64cd\u4f5c\u6210\u529f\uff0c\u4f46\u662f\u4e0d\u540c\u7684\u65b9\u6cd5\u53ef\u4ee5\u8fd4\u56de\u66f4\u7cbe\u786e\u7684\u72b6\u6001\u7801\u3002<\/p>\n<blockquote><p>\n  GET: 200 OK<br \/>\n  POST: 201 Created<br \/>\n  PUT: 200 OK<br \/>\n  PATCH: 200 OK<br \/>\n  DELETE: 204 No Content\n<\/p><\/blockquote>\n<p>\u4e0a\u9762\u4ee3\u7801\u4e2d\uff0cPOST\u8fd4\u56de201\u72b6\u6001\u7801\uff0c\u8868\u793a\u751f\u6210\u4e86\u65b0\u7684\u8d44\u6e90\uff1bDELETE\u8fd4\u56de204\u72b6\u6001\u7801\uff0c\u8868\u793a\u8d44\u6e90\u5df2\u7ecf\u4e0d\u5b58\u5728\u3002<br \/>\u6b64\u5916\uff0c202 Accepted\u72b6\u6001\u7801\u8868\u793a\u670d\u52a1\u5668\u5df2\u7ecf\u6536\u5230\u8bf7\u6c42\uff0c\u4f46\u8fd8\u672a\u8fdb\u884c\u5904\u7406\uff0c\u4f1a\u5728\u672a\u6765\u518d\u5904\u7406\uff0c\u901a\u5e38\u7528\u4e8e\u5f02\u6b65\u64cd\u4f5c\u3002<br \/>\n<a name=\"mUg9L\"><\/a><\/p>\n<h2>\u53c2\u8003<\/h2>\n<ol>\n<li><a class=\"wp-editor-md-post-content-link\" href=\"https:\/\/stackoverflow.blog\/2020\/03\/02\/best-practices-for-rest-api-design\/\">https:\/\/stackoverflow.blog\/2020\/03\/02\/best-practices-for-rest-api-design\/<\/a><\/li>\n<li><a class=\"wp-editor-md-post-content-link\" href=\"https:\/\/hackernoon.com\/restful-api-designing-guidelines-the-best-practices-60e1d954e7c9\">https:\/\/hackernoon.com\/restful-api-designing-guidelines-the-best-practices-60e1d954e7c9<\/a><\/li>\n<li><a class=\"wp-editor-md-post-content-link\" href=\"https:\/\/www.vinaysahni.com\/best-practices-for-a-pragmatic-restful-api\">https:\/\/www.vinaysahni.com\/best-practices-for-a-pragmatic-restful-api<\/a><\/li>\n<li>Azure \uff08 <a class=\"wp-editor-md-post-content-link\" href=\"https:\/\/docs.microsoft.com\/zh-cn\/azure\/architecture\/best-practices\/api-design\">https:\/\/docs.microsoft.com\/zh-cn\/azure\/architecture\/best-practices\/api-design<\/a> \uff09<\/li>\n<li>Google Cloud \uff08 <a class=\"wp-editor-md-post-content-link\" href=\"https:\/\/cloud.google.com\/apis\/design\/\">https:\/\/cloud.google.com\/apis\/design\/<\/a><\/li>\n<li>Zalendo \uff1a <a class=\"wp-editor-md-post-content-link\" href=\"https:\/\/opensource.zalando.com\/restful-api-guidelines\/\">https:\/\/opensource.zalando.com\/restful-api-guidelines\/<\/a> \uff0c\u5176\u4e2d\u6709\u975e\u5e38\u591a\u7684\u5b9e\u8df5\u662f\u53ef\u4ee5\u53c2\u8003\u7684\uff0c\u4e5f\u50cf RFC \u4e00\u6837\u89c4\u8303\u4e86 MUST \u3001SHOULD \u3001MAY \u7684\u9075\u5b88\u5206\u7ea7\u3002<br \/>\n<a name=\"Qx6jA\"><\/a><\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"<p>\u4e00 \u524d\u8a00 \u4f5c\u4e3a\u4e00\u540d\u540e\u7aef\u7a0b\u5e8f\u5458\uff0c\u7167\u7740\u4ea7\u54c1\u9700\u6c42\u8bbe\u8ba1\u597d\u4e86\u6a21\u578b\uff0c\u8bbe\u8ba1\u597d\u4e86\u5173\u8054\u5173\u7cfb\uff0c\u8bbe\u8ba1API\u65f6\u5019\u95ee\u9898\u6765\u4e86\uff1a\u4e00\u65e6 API [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[7],"tags":[],"class_list":["post-1367","post","type-post","status-publish","format-standard","hentry","category-development"],"_links":{"self":[{"href":"https:\/\/hesiwei.cn\/index.php?rest_route=\/wp\/v2\/posts\/1367","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/hesiwei.cn\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/hesiwei.cn\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/hesiwei.cn\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/hesiwei.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1367"}],"version-history":[{"count":0,"href":"https:\/\/hesiwei.cn\/index.php?rest_route=\/wp\/v2\/posts\/1367\/revisions"}],"wp:attachment":[{"href":"https:\/\/hesiwei.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1367"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/hesiwei.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1367"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/hesiwei.cn\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1367"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}