{"id":2644,"date":"2019-08-07T11:38:18","date_gmt":"2019-08-07T03:38:18","guid":{"rendered":"http:\/\/blog.eolinker.com\/?p=2644"},"modified":"2019-08-15T10:18:30","modified_gmt":"2019-08-15T02:18:30","slug":"%e5%af%b9api%e8%bf%9b%e8%a1%8c%e7%89%88%e6%9c%ac%e6%8e%a7%e5%88%b6%e7%9a%84%e9%87%8d%e8%a6%81%e6%80%a7%e5%92%8c%e5%ae%9e%e7%8e%b0%e6%96%b9%e5%bc%8f","status":"publish","type":"post","link":"http:\/\/blog.eolinker.com\/?p=2644","title":{"rendered":"\u5bf9API\u8fdb\u884c\u7248\u672c\u63a7\u5236\u7684\u91cd\u8981\u6027\u548c\u5b9e\u73b0\u65b9\u5f0f"},"content":{"rendered":"

<\/p>\n

\u6211\u5728API\u8bbe\u8ba1\u4e2d\u6536\u5230\u7684\u6700\u5e38\u89c1\u95ee\u9898\u4e4b\u4e00\u5c31\u662f\u5982\u4f55\u5bf9API\u8fdb\u884c\u7248\u672c\u63a7\u5236\u3002\u867d\u7136\u5e76\u975e\u6240\u6709API\u90fd\u5b8c\u5168\u76f8\u540c\uff0c\u4f46\u6211\u53d1\u73b0\u5728API\u7248\u672c\u63a7\u5236\u65b9\u9762\uff0c\u67d0\u4e9b\u6a21\u5f0f\u548c\u5b9e\u8df5\u9002\u7528\u4e8e\u5927\u591a\u6570\u56e2\u961f\u3002\u6211\u5df2\u7ecf\u5c06\u8fd9\u4e9b\u5185\u5bb9\u6536\u96c6\u8d77\u6765\uff0c\u4e0b\u9762\u5c06\u63d0\u4f9b\u4e00\u4e9b\u5173\u4e8e\u7248\u672c\u63a7\u5236\u7b56\u7565\u7684\u5efa\u8bae\uff0c\u8be5\u7b56\u7565\u5c06\u5e2e\u52a9\u5927\u591a\u6570API\u63d0\u4f9b\u5546\uff0c\u65e0\u8bba\u4ed6\u4eec\u662f\u5411\u5185\u90e8\u7f72API\uff0c\u8fd8\u662f\u5bf9\u5916\u7684API\u3002<\/p>\n

<\/p>\n

API<\/strong>\u7248\u672c\u771f\u7684\u90a3\u4e48\u91cd\u8981\u5417\uff1f<\/strong><\/h1>\n

API\u662f\u4f60\u4e0eAPI\u4f7f\u7528\u8005\u4e4b\u95f4\u5efa\u7acb\u7684\u7ebd\u5e26\u3002\u6b63\u5e38\u60c5\u51b5\u4e0b\uff0c\u4f60\u4eec\u4e4b\u95f4\u7684\u7ebd\u5e26\u4e0d\u4f1a\u8f7b\u6613\u7684\u65ad\u5f00\u3002\u7ebd\u5e26\u5305\u62ecURI\u6a21\u5f0f\uff0c\u6709\u6548\u8d1f\u8f7d\u7ed3\u6784\uff0c\u5b57\u6bb5\u548c\u53c2\u6570\u540d\u79f0\uff0c\u9884\u671f\u884c\u4e3a\u4ee5\u53ca\u5176\u4ed6\u5185\u5bb9\u3002\u8fd9\u79cd\u65b9\u6cd5\u7684\u6700\u5927\u597d\u5904\u662f\u663e\u800c\u6613\u89c1\u7684\uff1aAPI\u4f7f\u7528\u8005\u7684\u7406\u89e3\u4e0d\u4f1a\u53d8\u66f4\uff0c\u5e94\u7528\u7a0b\u5e8f\u53ef\u4ee5\u4fdd\u8bc1\u6301\u7eed\u6709\u6548\u3002<\/p>\n

\u4f46\u662f\uff0c\u6c38\u4e45\u4e0d\u53d8\u662f\u4e0d\u73b0\u5b9e\u7684\u3002\u6709\u65f6\u56e0\u4e3a\u4e1a\u52a1\u53d8\u5316\uff0c\u4f60\u53ef\u80fd\u9700\u8981\u5bf9API\u8fdb\u884c\u91cd\u5927\u6539\u53d8\u3002\u53d1\u751f\u8fd9\u79cd\u60c5\u51b5\u65f6\uff0c\u6700\u597d\u7684\u65b9\u5f0f\u662f\uff0c\u4f60\u786e\u4fdd\u4e0d\u4f1a\u505a\u4efb\u4f55\u4f1a\u5bfc\u81f4API\u4f7f\u7528\u8005\u4fee\u590d\u4ee3\u7801\u7684\u4e8b\u60c5\u3002<\/p>\n

<\/p>\n

\u6253\u7834\u4e0d\u95f4\u65ad\u7684\u53d8\u5316<\/strong><\/h1>\n

\u975e\u7834\u574f\u6027\u53d8\u66f4\u5f80\u5f80\u5c31\u50cf\u662f\u201c\u6dfb\u52a0\u5242\u201d\uff0c\u4e00\u822c\u662f\u6dfb\u52a0\u65b0\u5b57\u6bb5\u6216\u5d4c\u5957\u8d44\u6e90\u5230\u8d44\u6e90\u9648\u8ff0\uff0c\u53c8\u6216\u662f\u589e\u52a0\u65b0\u7684\u7aef\u70b9\uff0c\u5982PUT\u6216PATCH\u3002API\u4f7f\u7528\u8005\u4ece\u4e00\u5f00\u59cb\u5e94\u8be5\u6784\u5efa\u80fd\u591f\u9002\u5e94\u8fd9\u4e9b\u975e\u7834\u574f\u6027\u66f4\u6539\u7684\u5ba2\u6237\u7aef\u4ee3\u7801\u3002<\/p>\n

\u7a81\u7834\u6027\u53d8\u5316\u5305\u62ec\uff1a<\/strong><\/h1>\n

1.\u540d\u5b57\u6bb5\u6216\u8d44\u6e90\u8def\u5f84\uff0c\u901a\u5e38\u5728API\u53d1\u5e03\u540e\u4e3a\u4e86\u7edf\u4e00\u547d\u540d\u89c4\u8303\u3002<\/p>\n

2.\u66f4\u6539\u6709\u6548\u8d1f\u8f7d\u7ed3\u6784\uff0c\u4e00\u822c\u662f\u9002\u5e94\u4ee5\u4e0b\u5185\u5bb9\uff1a<\/p>\n

a.\u91cd\u547d\u540d\u6216\u5220\u9664\u5b57\u6bb5<\/p>\n

b.\u5c06\u5b57\u6bb5\u4ece\u5355\u4e2a\u503c\u66f4\u6539\u4e3a\u4e00\u5bf9\u591a\u5173\u7cfb\uff08\u6bd4\u5982\u4ece\u4e00\u4e2a\u5e10\u6237\u7684\u4e00\u4e2a\u7535\u5b50\u90ae\u4ef6\u5730\u5740\u79fb\u52a8\u5230\u8fd9\u4e2a\u5e10\u6237\u7684\u7535\u5b50\u90ae\u4ef6\u5730\u5740\u5217\u8868\uff09\u3002<\/p>\n

c.\u4fee\u6539\u4e86API\u7684URL\uff0c\u5bfc\u81f4\u8fd4\u56de\u7ed3\u679c\u4e0d\u4e00\u81f4\u7684\u60c5\u51b5\u3002<\/p>\n

\u7b80\u800c\u8a00\u4e4b\uff0c\u4e00\u65e6\u4f60\u5c06API\u5bf9\u5916\u516c\u5f00\u53d1\u5e03\uff0c\u4f60\u5c31\u5fc5\u987b\u4fdd\u6301\u5b83\u662f\u53ef\u7528\u7684\u5e76\u4e14\u4e0d\u4f1a\u5f71\u54cd\u5230\u4f7f\u7528\u8005\u7684\u3002\u5982\u679c\u60a8\u9047\u5230\u591a\u4e2a\u9879\u76ee\uff0c\u5219\u9700\u8981\u5bf9API\u8fdb\u884c\u7248\u672c\u63a7\u5236\uff0c\u4ee5\u9632\u6b62\u7834\u574f\u73b0\u6709\u7684API\u4f7f\u7528\u8005\u3002<\/p>\n

<\/p>\n

\u5b9a\u4e49API\u7248\u672c\u7b56\u7565<\/strong><\/h1>\n

\u4efb\u4f55\u4e0d\u65ad\u53d1\u5c55\u53d8\u5316\u7684API\u90fd\u9700\u8981API\u7248\u672c\u63a7\u5236\u7b56\u7565\u3002\u4f60\u7684API\u7248\u672c\u53ef\u4ee5\u9002\u5e94\u6839\u636eAPI\u4f7f\u7528\u8005\u7684\u671f\u671b\u800c\u5207\u6362\u4e0d\u540c\u7248\u672c\u53d8\u5f97\u6709\u6240\u4e0d\u540c\u3002\u6211\u901a\u5e38\u5efa\u8bae\u5c06\u4ee5\u4e0bAPI\u7248\u672c\u63a7\u5236\u7b56\u7565\u4f5c\u4e3a\u6574\u4f53API\u7ba1\u7406\u7cfb\u7edf\u7684\u4e00\u90e8\u5206\u3002<\/p>\n

1.\u5982\u679c\u4f60\u7684API\u5904\u4e8e\u65e9\u671f\u6d4b\u8bd5\u7248\u672c\u4e2d\uff0c\u4e3a\u4e86\u83b7\u5f97\u6d88\u8d39\u8005\u7684\u53cd\u9988\uff0c\u8bf7\u5efa\u7acb\u60a8\u7684API\u53ef\u80fd\u4f1a\u53d1\u751f\u53d8\u5316\u7684\u6b63\u786e\u671f\u671b\u3002\u5728\u6b64\u9636\u6bb5\u5185\uff0c\u4f60\u4f1a\u4fdd\u7559\u8fd9\u4e2a\u7248\u672c\u4e00\u6bb5\u65f6\u95f4\uff0c\u56e0\u4e3a\u4f60\u7684API\u8bbe\u8ba1\u53ef\u80fd\u8fd8\u4f1a\u66f4\u6539\u3002\u4f5c\u4e3a\u6d88\u8d39\u8005\uff0cAPI\u662f\u4e0d\u7a33\u5b9a\u7684\uff0c\u56e0\u6b64\u4ed6\u4eec\u5e94\u8be5\u9884\u671f\u5230\u53ef\u80fd\u4f1a\u53d1\u751f\u7684\u53d8\u5316\u3002<\/p>\n

2.\u4e00\u65e6\u53d1\u5e03\uff0c\u4f60\u7684API\u5e94\u88ab\u89c6\u4e3a\u5951\u7ea6\uff0c\u5982\u679c\u6ca1\u6709\u65b0\u7248\u672c\uff0c\u5219\u4e0d\u80fd\u88ab\u66ff\u6362\u3002<\/p>\n

3.\u4e0d\u95f4\u65ad\u7684\u66f4\u6539\u4f1a\u5bfc\u81f4\u6b21\u8981\u7248\u672c\u51fa\u73b0\u95ee\u9898\uff0c\u5ba2\u6237\u7aef\u4f1a\u81ea\u52a8\u8fc1\u79fb\u5230\u6700\u65b0\u7248\u672c\uff0c\u4e0d\u4f1a\u51fa\u73b0\u4efb\u4f55\u8d1f\u9762\u526f\u4f5c\u7528\u3002<\/p>\n

4.\u7a81\u7834\u6027\u7684\u53d8\u5316\u610f\u5473\u7740\u5ba2\u6237\u5fc5\u987b\u8fc1\u79fb\u5230\u6b64\u65b0\u7248\u672c\uff0c\u56e0\u4e3a\u5b83\u5305\u542b\u4e00\u4e2a\u6216\u591a\u4e2a\u91cd\u5927\u66f4\u6539\u3002\u4f60\u5fc5\u987b\u4e0eAPI\u4f7f\u7528\u8005\u5efa\u7acb\u9002\u5f53\u7684\u65f6\u95f4\u8868\u5e76\u5b9a\u671f\u6c9f\u901a\uff0c\u4ee5\u786e\u4fdd\u4ed6\u4eec\u80fd\u65b9\u4fbf\u5730\u8fc1\u79fb\u5230\u65b0\u7248\u672c\u3002\u4f46\u5728\u67d0\u4e9b\u60c5\u51b5\u4e0b\uff0c\u8fd9\u53ef\u80fd\u65e0\u6cd5\u9a6c\u4e0a\u5b9e\u73b0\uff0c\u6240\u4ee5\u4f60\u7684\u56e2\u961f\u5c06\u4f1a\u88ab\u8981\u6c42\u6682\u65f6\u6027\u652f\u6301\u4ee5\u524d\u7684API\u7248\u672c\u3002<\/p>\n

\u4f55\u65f6\u5fc5\u987b\u5b9e\u73b0API\u7248\u672c\u63a7\u5236<\/strong><\/h1>\n

\u4e00\u65e6\u786e\u5b9a\u9700\u8981\u65b0\u7248\u672c\u7684API\uff0c\u5c31\u9700\u8981\u77e5\u9053\u5982\u4f55\u5904\u7406\u5b83\u3002\u5b9e\u73b0API\u7248\u672c\u63a7\u5236\u6709\u4e09\u79cd\u5e38\u7528\u65b9\u6cd5\u3002<\/p>\n

1.\u8d44\u6e90\u7248\u672c\u63a7\u5236<\/p>\n

\u8be5\u7248\u672c\u662fHTTP\u8bf7\u6c42\u4e2dAccept\u6807\u5934\u7684\u4e00\u90e8\u5206\uff0c\u4f8b\u5982\uff0cAccept:application\/vnd.github.v3+json \u53d1\u9001\u5230GET \/customers\u3002\u8fd9\u8003\u8651\u4e86\u8bb8\u591a\u7248\u672c\u63a7\u5236\u7684\u9996\u9009\u5f62\u5f0f\uff0c\u56e0\u4e3a\u8d44\u6e90\u5728\u7248\u672c\u5316\u7684\u540c\u65f6\u9700\u8981\u4fdd\u6301URI\u76f8\u540c\u3002\u5982\u679c\u672a\u5728Accept\u6807\u5934\u4e2d\u63d0\u4f9b\uff0c\u67d0\u4e9bAPI\u4f1a\u9009\u62e9\u63d0\u4f9b\u6700\u65b0\u7248\u672c\u4f5c\u4e3a\u9ed8\u8ba4\u7248\u672c\u3002<\/p>\n

2.URI\u7248\u672c\u63a7\u5236<\/p>\n

\u8be5\u7248\u672c\u662fURI\u7684\u4e00\u90e8\u5206\uff0c\u4f5c\u4e3a\u524d\u7f00\u6216\u540e\u7f00\uff0c\u4f8b\u5982\uff0c\/v1\/customers \u6216\/customers\/v1\u3002\u867d\u7136URI\u7248\u672c\u63a7\u5236\u4e0d\u5982\u57fa\u4e8e\u5185\u5bb9\u7684\u7248\u672c\u63a7\u5236\u90a3\u4e48\u7cbe\u786e\uff0c\u4f46\u5b83\u5f80\u5f80\u662f\u6700\u5e38\u89c1\u7684\uff0c\u56e0\u4e3a\u5b83\u9002\u7528\u4e8e\u4e0d\u652f\u6301\u81ea\u5b9a\u4e49\u6807\u5934\u7684\u5404\u79cd\u5de5\u5177\u3002\u7f3a\u70b9\u662f\u8d44\u6e90URI\u968f\u6bcf\u4e2a\u65b0\u7248\u672c\u800c\u53d8\u5316\uff0c\u6709\u4e9b\u4eba\u8ba4\u4e3a\u8fd9\u4e0e\u62e5\u6709\u6c38\u4e0d\u6539\u53d8\u7684URI\u7684\u610f\u56fe\u80cc\u9053\u800c\u9a70\u3002<\/p>\n

3.\u4e3b\u673a\u540d\u7248\u672c\u63a7\u5236<\/p>\n

\u8be5\u7248\u672c\u662f\u4e3b\u673a\u540d\u7684\u4e00\u90e8\u5206\u800c\u4e0d\u662fURI\uff0c\u4f8b\u5982\uff0chttps:\/\/v2.api.myapp.com\/customers\u3002\u5f53\u6280\u672f\u9650\u5236\u963b\u6b62\u57fa\u4e8eURI\u6216Accept\u6807\u5934\u5230API\u7684\u6b63\u786e\u540e\u7aef\u7248\u672c\u65f6\uff0c\u5c06\u4f7f\u7528\u6b64\u65b9\u6cd5\u3002<\/p>\n

\u5907\u6ce8\uff1a<\/strong>\u65e0\u8bba\u60a8\u9009\u62e9\u54ea\u4e2a\u9009\u9879\uff0cAPI\u7248\u672c\u90fd\u53ea\u5e94\u5305\u542b\u4e3b\u8981\u7f16\u53f7\u3002\u4e0d\u9700\u8981\u5c0f\u6570\u5b57\uff08\u5373\u00a0 \/v1\/customers\uff0c\u4e0d\u662f\/v1.1\/customers\uff09\u3002<\/p>\n

<\/p>\n

\u5b9e\u73b0\u7248\u672c\u63a7\u5236\u7684\u5de5\u5177<\/h1>\n

\u4f7f\u7528\u5de5\u5177\u548c\u6280\u672f\u53ef\u4ee5\u4ece\u6839\u672c\u4e0a\u5b9e\u73b0API\u7248\u672c\u63a7\u5236\u8fc7\u7a0b\u3002\u7528\u5e02\u573a\u4e0a\u4f18\u79c0\u7684API\u7f16\u8f91\u5668\u5c06\u4f7f\u6280\u672f\u5f00\u53d1\u56e2\u961f\u80fd\u591f\u5728\u66f4\u77ed\u7684\u65f6\u95f4\u5185\u751f\u6210\u5e76\u5207\u6362\u66f4\u591a\u7684API\u7248\u672c\uff0c\u4ece\u800c\u4e0d\u65ad\u6539\u8fdb\u8bbe\u8ba1\u51b3\u7b56\u3002<\/p>\n

\u7ed3\u5408\u5de5\u5177\u8fdb\u884c\u7248\u672c\u63a7\u5236\u662f\u5927\u591a\u6570\u5f00\u53d1\u8fc7\u7a0b\u7684\u91cd\u8981\u7ec4\u6210\u90e8\u5206\u3002API\u8bbe\u8ba1\u9886\u57df\u4e2d\u4e5f\u6709\u8fd9\u79cd\u80fd\u7248\u672c\u63a7\u5236\u7684\u5de5\u5177\uff0c\u5b9e\u9645\u4e0a\uff0c\u5168\u7403\u8303\u56f4\u5185API\u670d\u52a1\u9886\u57df\u4e2d\u5df2\u7ecf\u5b58\u5728\u4e00\u4e9b\u4f18\u79c0\u7684Web API\u8bbe\u8ba1\u5de5\u5177\u3002<\/p>\n

\u73b0\u5728\uff0c\u5982EOLINKER\u3001RAML\u3001Swagger\uff0c\u90fd\u63d0\u4f9b\u4e86\u51fa\u8272\u7684\u7f16\u8f91\u5de5\u5177\u6765\u652f\u6301\u4ed6\u4eec\u7684\u8bed\u8a00\u3002EOLINKER\u91c7\u7528\u7684\u662f\u7248\u672c\u5bf9\u6bd4\u548c\u91cd\u70b9\u6807\u6ce8\u63d0\u793a\uff0c\u53ef\u4ee5\u6e05\u6670\u7684\u5207\u6362\u3001\u5bf9\u6bd4\u3002RAML\u3001Swagger\u91c7\u7528\u7684\u662f\u7248\u672c\u5207\u6362\uff0c\u65b9\u4fbf\u7a0b\u5ea6\u53ef\u80fd\u7565\u900a\u4e00\u70b9\u3002\u800c\u4e14\u53ea\u6709\u524d\u8005\u662f\u652f\u6301\u4e2d\u6587\u7684\uff0c\u540e\u4e24\u79cd\u53ea\u652f\u6301\u82f1\u6587\u8bed\u8a00\u3002\u8fd9\u4e9bAPI\u7f16\u8f91\u5668\u90fd\u80fd\u8f7b\u677e\u5730\u5b9e\u73b0API\u7248\u672c\u7684\u63a7\u5236\uff0c\u4f7f\u5f97\u66f4\u5bb9\u6613\u5728\u66f4\u77ed\u7684\u65f6\u95f4\u5185\u5207\u6362\u8fd0\u884c\u7248\u672c\u3002\u9644\u4e0aEOLINKER\u7684\u5b98\u65b9\u7f51\u5740\uff1ahttps:\/\/www.eolinker.com<\/p>\n

<\/p>\n

\u6700\u540e\u7684\u60f3\u6cd5<\/strong><\/h1>\n

\u8bf7\u8bb0\u4f4f\uff0cAPI\u662f\u4e0e\u4f60\u7684\u6d88\u8d39\u8005\u94fe\u63a5\u7684\u67a2\u7ebd\u3002\u6253\u7834\u65e7\u7684\u8fde\u63a5\uff0c\u5c31\u9700\u8981\u65b0\u7248\u672c\u3002\u9009\u62e9\u7b56\u7565\uff0c\u5236\u5b9a\u8ba1\u5212\uff0c\u5e76\u4e0eAPI\u4f7f\u7528\u8005\u6c9f\u901a\u8be5\u8ba1\u5212\uff0c\u8fd9\u624d\u662f\u7248\u672c\u63a7\u5236\u7684\u6700\u7ec8\u76ee\u7684\u3002<\/p>\n

 <\/p>\n

\u53c2\u8003\u8d44\u6599\uff1aJames Higginbotham\uff0cWhen and How Do You Version Your API?<\/em><\/p>\n

\u539f\u6587\u5730\u5740\uff1ahttps:\/\/dzone.com\/articles\/when-and-how-do-you-version-your-api<\/a><\/em><\/p>\n","protected":false},"excerpt":{"rendered":"

\u6211\u5728API\u8bbe\u8ba1\u4e2d\u6536\u5230\u7684\u6700\u5e38\u89c1\u95ee\u9898\u4e4b\u4e00\u5c31\u662f\u5982\u4f55\u5bf9API\u8fdb\u884c\u7248\u672c\u63a7\u5236\u3002\u867d\u7136\u5e76\u975e\u6240\u6709API\u90fd\u5b8c\u5168\u76f8\u540c\uff0c\u4f46\u6211\u53d1\u73b0\u5728AP […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[2],"tags":[],"_links":{"self":[{"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=\/wp\/v2\/posts\/2644"}],"collection":[{"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=2644"}],"version-history":[{"count":10,"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=\/wp\/v2\/posts\/2644\/revisions"}],"predecessor-version":[{"id":2714,"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=\/wp\/v2\/posts\/2644\/revisions\/2714"}],"wp:attachment":[{"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=2644"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=2644"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=2644"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}