{"id":2422,"date":"2019-07-05T17:49:42","date_gmt":"2019-07-05T09:49:42","guid":{"rendered":"http:\/\/blog.eolinker.com\/?p=2422"},"modified":"2019-11-15T15:58:57","modified_gmt":"2019-11-15T07:58:57","slug":"%e9%9a%8f%e6%97%b6%e5%8f%91%e5%b8%83%ef%bc%9arest-api%e6%96%87%e6%a1%a3%e7%9a%84%e4%bb%a3%e7%a0%81%e4%bb%93%e5%ba%93%e4%b8%ad%e7%9a%84%e6%8c%81%e7%bb%ad%e9%9b%86%e6%88%90%e4%b8%8e%e5%8d%8f%e4%bd%9c","status":"publish","type":"post","link":"http:\/\/blog.eolinker.com\/?p=2422","title":{"rendered":"\u968f\u65f6\u53d1\u5e03\uff1aREST API\u6587\u6863\u7684\u4ee3\u7801\u4ed3\u5e93\u4e2d\u7684\u6301\u7eed\u96c6\u6210\u4e0e\u534f\u4f5c"},"content":{"rendered":"

<\/h1>\n

\u672c\u6587\u4e3b\u8981\u4ecb\u7ecd\u4ee5\u4e0b\u7684\u5185\u5bb9\uff1aAPI\u6587\u6863\u63d0\u4f9b\u4e86\u9884\u6d4b\u5ba2\u6237\u6210\u529f\u7684\u5173\u952e\u8def\u5f84\uff1b\u5728\u4ee3\u7801\u9644\u8fd1\u7684\u6587\u6863\u4e0a\u8fdb\u884c\u534f\u4f5c\u53ef\u4ee5\u66f4\u597d\u5730\u68c0\u67e5\u4ee3\u7801\u548c\u6587\u6863\u6587\u4ef6\uff0c\u63d0\u9ad8\u81ea\u52a8\u5316\u6548\u7387\uff0c\u5e76\u4e13\u95e8\u9488\u5bf9\u6587\u6863\u8fdb\u884c\u8d28\u91cf\u6d4b\u8bd5\uff1b\u63d0\u4f9b\u901a\u7528\u6587\u6863\u6846\u67b6\uff0c\u6807\u51c6\uff0c\u81ea\u52a8\u5316\u548c\u5de5\u5177\uff0c\u4ee5\u63d0\u9ad8\u56e2\u961f\u6548\u7387\u3002\u8be6\u60c5\u8bf7\u67e5\u770b\u5168\u6587\u3002<\/p>\n

<\/p>\n

\u7f16\u5199\u6587\u6863\u6709\u65f6\u5019\u4f1a\u975e\u5e38\u67af\u71e5\u4e4f\u5473\uff0c\u4f46\u4f18\u79c0\u7684\u6587\u6863\u662f\u589e\u52a0API\u88ab\u91c7\u7528\u7684\u4e00\u4e2a\u5f88\u597d\u7684\u524d\u63d0\u3002\u7f16\u5199\u51fa\u8272\u7684\u6587\u6863\u4e0e\u7f16\u5199\u4ee3\u7801\u4e00\u6837\u9700\u8981\u4e25\u8c28\u3002\u968f\u7740API\u7684\u8d28\u91cf\u9010\u6e10\u6210\u4e3a\u4ea7\u54c1\u589e\u957f\u7684\u6307\u6807\uff0c\u60a8\u7684\u6587\u6863\u6bd4\u4ee5\u5f80\u4efb\u4f55\u65f6\u5019\u90fd\u66f4\u52a0\u91cd\u8981\uff0c\u4f18\u79c0\u7684\u6587\u6863\u5f88\u5927\u7a0b\u5ea6\u4e0a\u4ee3\u8868\u521b\u5efa\u4e86\u6210\u529f\u7684API\u3002API\u5b9a\u4e49\u548c\u6587\u6863\u5e38\u5e38\u7ed3\u5408\u5728\u4e00\u8d77\uff0c\u867d\u7136\u4eca\u5929\u7684API\u89c4\u8303\u8d8a\u6765\u8d8a\u591a\u5730\u4f5c\u4e3aGitHub\u4e2d\u7684\u4ee3\u7801\u8fdb\u884c\u7ba1\u7406\uff0c\u4f46API\u6587\u6863\u5e76\u975e\u5982\u6b64\u3002\u6240\u4ee5\u9700\u8981\u8ba9\u6211\u4eec\u5bf9\u6b64\u8fdb\u884c\u66f4\u6539\uff0c\u4ee5\u4fbf\u5728GitHub\u548c\u76f8\u5173\u4ee3\u7801\u5e93\u4e2d\u7f16\u5199\u548c\u7ba1\u7406API\u6587\u6863\uff08\u5305\u62ec\u76f8\u5173\u7f51\u7ad9\uff09\u7684\u6807\u51c6\u3002<\/p>\n

\u901a\u8fc7\u5c3d\u53ef\u80fd\u9760\u8fd1\u4ee3\u7801\u548cAPI\u5b9a\u4e49\u534f\u4f5c\u7f16\u5199\u6587\u6863\uff0c\u60a8\u53ef\u4ee5\u81ea\u52a8\u6267\u884c\u6587\u6863\u6d4b\u8bd5\uff0c\u6784\u5efa\u548c\u90e8\u7f72\u3002API\u7684\u6587\u6863\u901a\u5e38\u6784\u5efa\u4e3a\u7f51\u7ad9\uff0c\u56e0\u6b64\u5982\u679c\u5728\u5206\u6bb5\u6784\u5efa\u671f\u95f4\u5c31\u53ef\u4ee5\u8fdb\u884c\u94fe\u63a5\u68c0\u67e5\u7b49\u6d4b\u8bd5\u3002\u8fd9\u79cd\u65b9\u6cd5\u63d0\u4f9b\u4e86\u8bb8\u591a\u597d\u5904\uff1a\u7ecf\u8fc7\u6d4b\u8bd5\u7684\u6587\u6863\u6784\u5efa\uff1b\u652f\u6301\u8fde\u7eed\u53d1\u5e03\uff1b\u652f\u6301\u5bf9\u6587\u6863\u5185\u5bb9\u548c\u4ee3\u7801\u7684\u8bc4\u8bba\uff1b\u591a\u4e2a\u8f93\u51fa\uff08\u5305\u62ec\u7ecf\u8fc7\u6d4b\u8bd5\u7684\u4ee3\u7801\u793a\u4f8b\uff09\uff1b\u6587\u6863\u7684\u53d1\u5e03\u7ba1\u7406\uff08\u5982API\u7684\u65e9\u671f\u8bbf\u95ee\u7248\u672c\uff09\u6216\u589e\u91cf\u66f4\u6539\u548c\u6dfb\u52a0\u5230\u53d1\u5e03\u4e86API\uff0c\u5e76\u9632\u6b62\u4ee3\u7801\u5408\u5e76\u3002<\/p>\n

\u6587\u6863\u6301\u7eed\u96c6\u6210\/\u4ea4\u4ed8<\/h1>\n

\u5bf9\u4e8eREST API\u6587\u6863\uff0c\u4e09\u4e2a\u6846\u67b6\u4ee5\u7f51\u9875\u7684\u5f62\u5f0f\u63d0\u4f9b\u6587\u6863\u8f93\u51fa\uff0c\u5176\u4e2d\u8bb8\u591a\u662f\u4ea4\u4e92\u5f0f\u7684\u3002\u8fd9\u4e9b\u662fOpenAPI\uff08Swagger\uff09\uff0cRESTful API\u5efa\u6a21\u8bed\u8a00\uff08RAML\uff09\u548cAPI\u84dd\u56fe\u3002OpenAPI\uff08\u4ee5\u524d\u79f0\u4e3aSwagger\uff09\u57fa\u4e8eJSON\u8f93\u51fa\uff0c\u7531\u4e8eYAML\u662fJSON\u7684\u8d85\u96c6\uff0c\u56e0\u6b64\u60a8\u53ef\u4ee5\u4ea4\u6362\u63cf\u8ff0API\u7684\u6e90\u6587\u4ef6\u3002RAML\u662f\u4e00\u79cd\u57fa\u4e8eYAML\u7684\u8bed\u8a00\uff0c\u7528\u4e8e\u63cf\u8ff0REST API\u3002API Blueprint\u4f7f\u7528Markdown\uff0c\u4e5f\u53ef\u4ee5\u9075\u5faaGitHub Flavored Markdown\u8bed\u6cd5\u3002<\/p>\n

\u8bb8\u591a\u7f16\u7a0b\u8bed\u8a00\u90fd\u6709\u4e00\u4e2a\u6587\u6863\u6846\u67b6\uff0c\u53ef\u4ee5\u5f88\u597d\u5730\u4e0e\u4ee3\u7801\u672c\u8eab\u96c6\u6210\u3002\u901a\u5e38\uff0c\u8fd9\u4e9b\u662f\u9759\u6001\u7ad9\u70b9\u751f\u6210\u5668\uff0c\u4f8b\u5982Jekyll for Ruby\u548cSphinx for Python\u3002\u6587\u6863\u7684\u6e90\u6587\u4ef6\u662fMarkdown\u6216reStructured Text\uff08RST\uff09\u3002\u4f7f\u7528\u8fd9\u4e9b\u9759\u6001\u7ad9\u70b9\u751f\u6210\u5668\uff0c\u60a8\u53ef\u4ee5\u521b\u5efa\u6f02\u4eae\u7684\u6587\u6863\u7ad9\u70b9\u3002\u4e8b\u5b9e\u4e0a\uff0cGitHub\u4e0a\u6709\u4e00\u7cfb\u5217\u94fe\u63a5\u5230\u6f02\u4eae\u7684\u6587\u6863\u7f51\u7ad9\uff0c\u5176\u4e2d\u5305\u62ecStripe API\u6587\u6863\u7ad9\u70b9\u548cBasho\u6587\u6863\u00a0– \u8fd9\u4e9b\u662f\u83b7\u5f97\u7f8e\u89c2\u548c\u5b9e\u7528\u7a0b\u5e8f\u6700\u9ad8\u5206\u7684\u793a\u4f8bAPI\u7ad9\u70b9\u3002<\/p>\n

\u7531\u4e8e\u53ef\u4ee5\u4f7f\u7528\u811a\u672c\u8f6c\u6362\u8fd9\u4e9b\u6587\u6863\u6e90\u6587\u4ef6\u548c\u7f51\u7ad9\u914d\u7f6e\u6587\u4ef6\uff0c\u56e0\u6b64\u60a8\u53ef\u4ee5\u4f7f\u7528\u4e0e\u4ee3\u7801\u76f8\u540c\u7684\u6784\u5efa\u4f5c\u4e1a\u6765\u6301\u7eed\u6784\u5efa\u6587\u6863\u3002\u901a\u8fc7\u4ece\u9759\u6001\u76ee\u5f55\u590d\u5236\u5e73\u9762\u6587\u4ef6\u6765\u90e8\u7f72Jekyll\u7ad9\u70b9\uff0c\u56e0\u6b64\u60a8\u53ef\u4ee5\u5b58\u50a8\u811a\u672c\u4ee5\u4f7f\u7528\u5176\u4ed6\u6784\u5efa\u6587\u4ef6\u5728\u4ee3\u7801\u5b58\u50a8\u5e93\u4e2d\u6784\u5efa\u7ad9\u70b9\u3002\u60a8\u8fd8\u53ef\u4ee5\u4f7f\u7528\u7b80\u5355\u7684\u94fe\u63a5\u68c0\u67e5\u7a0b\u5e8f\u5728\u90e8\u7f72\u7ad9\u70b9\u4e4b\u524d\u6d4b\u8bd5\u4efb\u4f55\u635f\u574f\u7684\u94fe\u63a5\u3002HTMLProofer\u5e93\u662f\u4e00\u4e2a\u4e3a\u6b64\u800c\u7f16\u5199\u7684Ruby\u5e93\u3002<\/p>\n

GitHub\u63d0\u4f9b\u7684\u90e8\u7f72\u673a\u5236\u79f0\u4e3aGitHub Pages\u3002\u60a8\u53ef\u4ee5\u9009\u62e9\u89e6\u53d1\u6587\u6863\u7f51\u7ad9\u90e8\u7f72\u3002\u60a8\u53ef\u4ee5\u4ecegh-pages\u5206\u652f\uff0c\u4e3b\u5206\u652f\u81ea\u52a8\u5316\u6784\u5efa\uff0c\u6216\u59cb\u7ec8\u4ece\u4e3b\u5206\u652f\u4e0a\u7684\/ docs\u76ee\u5f55\u90e8\u7f72\u6587\u6863\u3002\u867d\u7136\u60a8\u53ef\u4ee5\u90e8\u7f72\u5230\u81ea\u5b9a\u4e49\u57df\u540d\uff0c\u4f46GitHub\u9875\u9762\u7684\u4e00\u4e2a\u9650\u5236\u662f\u60a8\u4e0d\u80fd\u76f4\u63a5\u901a\u8fc7HTTPS\u63d0\u4f9b\u670d\u52a1\uff0c\u4f46\u4f5c\u4e3a\u514d\u8d39\u670d\u52a1\uff0c\u5b83\u662f\u4e00\u4e2a\u5f88\u597d\u7684\u8d77\u70b9\u3002\u5bf9\u4e8e\u751f\u4ea7\u7f51\u7ad9\uff0c\u60a8\u53ef\u4ee5\u4eceGitHub\u90e8\u7f72\u5230\u5177\u6709\u6240\u9700\u5b89\u5168\u8981\u6c42\u7684\u4e91\u670d\u52a1\u5668\u6216VPS\u3002\u800cGitHub Enterprise\u662fGitHub\u7684\u5185\u90e8\u90e8\u7f72\uff0c\u7528\u4e8e\u5185\u90e8\u90e8\u7f72\uff0c\u63d0\u4f9b\u7c7b\u4f3c\u7684\u6258\u7ba1\u7ad9\u70b9\u529f\u80fd\u3002<\/p>\n

\u4e3a\u4ec0\u4e48\u8981\u50cf\u4ee3\u7801\u4e00\u6837\u5904\u7406\u6587\u6863<\/h1>\n

\u5f53\u6210\u679c\u5df2\u7ecf\u53ef\u4ee5\u4ea4\u4ed8\u7ed9\u5f00\u53d1\u4eba\u5458\u65f6\uff0c\u90a3\u4e0e\u5f00\u53d1\u4eba\u5458\u4e00\u8d77\u5199\u6587\u6863\u4f1a\u5f88\u6709\u6548\u3002API\u6587\u6863\u4efb\u52a1\u4e3a\u5904\u7406\u4ee3\u7801\u7b49\u6587\u6863\u7684\u539f\u56e0\u548c\u65f6\u95f4\u63d0\u4f9b\u4e86\u4e00\u4e2a\u5f88\u597d\u7684\u793a\u4f8b\u3002\u7279\u522b\u662f\u5728\u8bbe\u8ba1API\u6216\u5411API\u6dfb\u52a0\u529f\u80fd\u65f6\u7684\u5173\u952e\u8bbe\u8ba1\u70b9\uff0c\u5f00\u53d1\u4eba\u5458\u53ef\u4ee5\u50cf\u6587\u6863\u4ee3\u7801\u4e00\u6837\u8d21\u732e\u6587\u6863\u3002<\/p>\n

\u4f8b\u5982\uff0c\u5728\u81ea\u52a8\u5316\u53c2\u8003\u4fe1\u606f\u65f6\uff0c\u60a8\u53ef\u4ee5\u83b7\u5f97\u5373\u65f6\u6027\u548c\u51c6\u786e\u6027\uff0c\u5e76\u901a\u8fc7\u5728GitHub\uff0cBitbucket\u6216GitLab\u7b49\u793e\u4ea4\u7f16\u7801\u7cfb\u7edf\u4e2d\u534f\u4f5c\u7f16\u5199\u6765\u83b7\u5f97\u8d21\u732e\uff0c\u8d28\u91cf\u548c\u540c\u7406\u5fc3\u3002\u6b64\u5916\uff0cAPI\u7684\u6700\u5927\u6210\u529f\u6307\u6807\u4e4b\u4e00\u662f\u6587\u6863\u7684\u51c6\u786e\u6027\u548c\u6709\u7528\u6027\u3002\u5f53\u60a8\u7684\u56e2\u961f\u5904\u7406\u4ee3\u7801\u7b49API\u6587\u6863\u65f6\uff0c\u4ee5\u4e0b\u662f\u4e00\u4e9b\u7279\u5b9a\u7684\u597d\u5904\uff0c\u4e0b\u9762\u5c06\u5bf9\u6b64\u8fdb\u884c\u66f4\u6df1\u5165\u7684\u63a2\u8ba8\uff1a<\/p>\n

1.\u534f\u4f5c\u6548\u7387<\/h3>\n

\u53ef\u4ee5\u4e3a\u5f00\u53d1\u4eba\u5458\u548c\u6587\u7ae0\u534f\u4f5c\u7f16\u5199\u8005\u4e24\u4e2a\u89d2\u8272\u63d0\u4f9b\u6709\u4ef7\u503c\u7684\u4fe1\u606f\u3002\u5f00\u53d1\u4eba\u5458\u5e0c\u671b\u4e3a\u7c7b\u4f3c\u4e8e\u81ea\u5df1\u7684\u53d7\u4f17\u64b0\u5199\u6587\u7ae0\uff0c\u4e3a\u8bfb\u8005\u63d0\u4f9b\u7ecf\u9a8c\u5206\u4eab\u3002\u534f\u4f5c\u7f16\u5199\u8005\u6709\u4e00\u4e2a\u7279\u6b8a\u7684\u8bc0\u7a8d\u6765\u7ec4\u7ec7\u4fe1\u606f\uff0c\u6587\u7b14\u66f4\u597d\uff0c\u5e76\u4ee5\u9002\u5f53\u7684\u987a\u5e8f\u63ed\u793a\u6982\u5ff5\u548c\u53c2\u8003\u4fe1\u606f\u3002\u5982\u679c\u5728\u540c\u4e00\u4e2a\u5b58\u50a8\u5e93\u4e2d\u534f\u540c\u5de5\u4f5c\u53ef\u4ee5\u63d0\u4f9b\u6c9f\u901a\u7684\u6548\u7387\uff0c\u589e\u52a0\u6559\u5b66\u548c\u88ab\u6559\u5b66\u7684\u673a\u4f1a\u3002<\/p>\n

2.\u8d21\u732e\u6536\u76ca<\/h3>\n

\u5f53\u6ca1\u6709\u4e13\u95e8\u7684\u6280\u672f\u5199\u4f5c\u56e2\u961f\u65f6\uff0c\u4f60\u53ef\u4ee5\u6269\u5927\u8d21\u732e\u8005\u7684\u6570\u91cf\uff0c\u5373\u4f7fAPI\u672c\u8eab\u4e0d\u662f\u516c\u5171\u6587\u6863\u7684\u516c\u5171\u6587\u4ef6\u3002\u6216\u8005\uff0c\u60a8\u53ef\u4ee5\u901a\u8fc7\u5728GitHub\u6216Bitbucket\u7b49\u7248\u672c\u63a7\u5236\u7cfb\u7edf\u4e2d\u63d0\u4f9b\u5f00\u6e90\u6587\u6863\u5b58\u50a8\u5e93\uff0c\u4ece\u6700\u7ec8\u7528\u6237\u81ea\u5df1\u83b7\u5f97\u66f4\u591a\u8d21\u732e\u3002\u5f53\u6587\u6863\u4e0e\u4ee3\u7801\u4f4d\u4e8e\u540c\u4e00\u5b58\u50a8\u5e93\u4e2d\u65f6\uff0c\u4efb\u4f55\u611f\u5174\u8da3\u7684\u5f00\u53d1\u4eba\u5458\uff08\u5305\u62ec\u5ba2\u6237\uff09\u90fd\u53ef\u4ee5\u8ba2\u9605\u62c9\u53d6\u8bf7\u6c42\u7684\u901a\u77e5\u3002<\/p>\n

3.\u8ddf\u8e2a\u6587\u6863\u4e2d\u7684\u9519\u8bef<\/h3>\n

\u8981\u83b7\u5f97\u66f4\u9ad8\u8d28\u91cf\u7684\u6587\u6863\uff0c\u8bf7\u63d0\u4f9b\u76f4\u63a5\u5728\u8f93\u51fa\u9875\u9762\u4e0a\u62a5\u544a\u6587\u6863\u9519\u8bef\u7684\u65b9\u6cd5\u3002\u6b63\u5982\u83b1\u7eb3\u65af\u5b9a\u5f8b\u6240\u8ff0\uff0c\u201c\u7ed9\u4e88\u8db3\u591f\u7684\u773c\u7403\uff0c\u6240\u6709\u7684\u9519\u8bef\u90fd\u662f\u6d45\u8584\u7684\u201d\u3002\u901a\u8fc7\u4e3a\u8fd9\u4e9b\u773c\u7403\u63d0\u4f9b\u62a5\u544a\u9519\u8bef\u7684\u4f4d\u7f6e\uff0c\u60a8\u53ef\u4ee5\u4e3a\u6587\u6863\u63d0\u4f9b\u66f4\u591a\u7c7b\u4f3c\u4ee3\u7801\u7684\u8d28\u91cf\u8ddf\u8e2a\u3002\u6b64\u5916\uff0c\u901a\u8fc7\u95ee\u9898\u8ddf\u8e2a\u5236\u5b9a\u7684\u6307\u6807\uff0c\u60a8\u53ef\u4ee5\u8861\u91cf\u6587\u6863\u7684\u8d28\u91cf\uff0c\u5e76\u786e\u4fdd\u5728\u9700\u8981\u89e3\u51b3\u8fd9\u4e9b\u9519\u8bef\u65f6\u53ef\u4f7f\u7528\u6307\u6807\u6765\u5224\u65ad\u3002<\/p>\n

4.\u5bf9\u6587\u6863\u548c\u4ee3\u7801\u7684\u8bc4\u8bba<\/h3>\n

\u5728\u67e5\u770b\u4ee3\u7801\u4e2d\u5305\u542b\u7684\u6587\u6863\u65f6\uff0c\u5ba1\u9605\u8005\u53ef\u4ee5\u5728\u6587\u6863\u4e0d\u8db3\u65f6\u963b\u6b62\u5bf9\u4ee3\u7801\u7684\u66f4\u6539\u3002\u8be5\u5ba1\u67e5\u6307\u5357\u4e3a\u56e2\u961f\u63d0\u4f9b\u4e86\u4f7f\u6587\u6863\u5177\u6709\u9ad8\u8d28\u91cf\u7684\u80fd\u529b\uff0c\u5373\u4f7f\u5b83\u4eec\u5fc5\u987b\u4e0e\u5feb\u901f\u53d8\u5316\u7684\u4ee3\u7801\u540c\u6b65\u3002<\/p>\n

\u5c06\u6587\u6863\u6e90\u6587\u4ef6\u653e\u5728\u50cfGitHub\u8fd9\u6837\u7684\u5f00\u653e\u7cfb\u7edf\u4e2d\u53ef\u4ee5\u4f7f\u5185\u5bb9\u5177\u6709\u5f00\u653e\u8d21\u732e\uff0c\u7c7b\u4f3c\u4e8e\u5f00\u6e90\u4ee3\u7801\u3002\u5728OpenStack\u4e2d\uff0c\u5927\u91cf\u7684\u5f00\u6e90\u4e91\u9879\u76ee\uff0c\u6587\u6863\u8d21\u732e\u8fc7\u7a0b\u4e0e\u4ee3\u7801\u8d21\u732e\u8fc7\u7a0b\u76f8\u540c\u3002\u7f16\u5199\u8005\u548c\u5f00\u53d1\u4eba\u5458\u5728\u8bbf\u95ee\u4ec5\u6587\u6863\u5b58\u50a8\u5e93\uff08\u4ec5\u4ee3\u7801\u5b58\u50a8\u5e93\uff09\u65f6\u5177\u6709\u76f8\u540c\u7684\u534f\u4f5c\u5de5\u5177\u548c\u80cc\u666f\u77e5\u8bc6\u3002<\/p>\n

\u5f53\u60a8\u7684API\u5b9a\u4e49\u9700\u8981\u4e00\u5b9a\u7a0b\u5ea6\u7684\u5b88\u95e8\u6216\u5c0f\u5fc3\u9632\u62a4\u65f6\uff0c\u60a8\u8fd8\u53ef\u4ee5\u8003\u8651\u5c06GitHub Enterprise\u7528\u4e8e\u5185\u90e8API\u6587\u6863\u3002\u60a8\u7684\u56e2\u961f\u4ecd\u7136\u53ef\u4ee5\u5728\u5185\u90e8\u83b7\u5f97\u534f\u4f5c\u4f18\u52bf\uff0c\u800c\u65e0\u9700\u5411\u5168\u4e16\u754c\u6253\u5f00\u60a8\u7684\u6587\u6863\u548c\u4ee3\u7801\u3002<\/p>\n

5.\u90e8\u7f72\u548c\u53d1\u5e03<\/h3>\n

\u5904\u7406\u4ee3\u7801\u7b49\u6587\u6863\u65f6\uff0c\u610f\u8bc6\u5230\u60a8\u6b63\u5728\u5c06\u6784\u5efa\u4e0e\u90e8\u7f72\u5206\u79bb\u3002\u901a\u8fc7\u8fd9\u79cd\u65b9\u5f0f\uff0c\u60a8\u53ef\u4ee5\u5bf9\u6587\u6863\u7684\u65e9\u671f\u8349\u7a3f\u8fdb\u884c\u5ba1\u6838\uff0c\u5e76\u4e14\u5728\u6587\u6863\u6784\u5efa\u90e8\u7f72\u5e76\u53d1\u5e03\u5230\u7f51\u7ad9\u4e4b\u524d\uff0c\u5b83\u90fd\u53ef\u4ee5\u968f\u65f6\u8fdb\u884c\u4fee\u6b63\u3002\u6216\u8005\uff0c\u60a8\u53ef\u4ee5\u9009\u62e9\u4e0d\u65ad\u53d1\u5e03\u4e00\u4e9b\u6587\u6863\u4ee5\u8ddf\u4e0a\u4ee3\u7801\u3002\u4f8b\u5982\uff0c\u60a8\u53ef\u4ee5\u9009\u62e9\u7f16\u5199\u53d9\u8ff0\u6027\u6587\u6863\u548c\u6559\u7a0b\uff0c\u8fd9\u4e9b\u6587\u6863\u548c\u6559\u7a0b\u4f1a\u968f\u7740\u6bcf\u4e2a\u8865\u4e01\u96c6\u6dfb\u52a0\u800c\u4e0d\u65ad\u53d1\u5e03\u3002\u4f46\u5bf9\u4e8e\u50cfOpenAPI\u89c4\u8303\u8fd9\u6837\u7684\u5408\u540c\u6587\u6863\uff0c\u53ea\u6709\u5728\u8003\u8651\u5728\u7279\u5b9a\u7248\u672c\u4e0b\u53d1\u5e03API\u65f6\uff0c\u624d\u80fd\u90e8\u7f72\u65b0\u6587\u6863\u3002<\/p>\n

6.\u6d4b\u8bd5\u548c\u6784\u5efa\u6587\u6863<\/h3>\n

\u901a\u8fc7\u4e3a\u8bc4\u8bba\u63d0\u4f9b\u5339\u914d\u7684\u5206\u6bb5\u6784\u5efa\u548c\u5411\u8bfb\u8005\u4ea4\u4ed8\u7684\u751f\u4ea7\u6784\u5efa\uff0c\u60a8\u53ef\u4ee5\u786e\u4fe1\u60a8\u5bf9\u6784\u5efa\u7684\u6587\u6863\u7684\u5ba1\u6838\u6ee1\u8db3\u7528\u6237\u9700\u6c42\u3002\u8bf7\u53c2\u9605\u4ee5\u4e0b\u90e8\u5206\u4e2d\u7684\u793a\u4f8b\u3002<\/p>\n

docs\u7684\u793a\u4f8b\u6d4b\u8bd5<\/h1>\n

\u60a8\u53ef\u4ee5\u6d4b\u8bd5\u6587\u6863\u6e90\u6587\u4ef6\u7684\u8d28\u91cf\u4ee5\u53ca\u662f\u5426\u6784\u5efa\u3002\u60a8\u8fd8\u53ef\u4ee5\u68c0\u67e5\u62fc\u5199\u6216\u8bed\u6cd5\uff0c\u4f46\u4e5f\u53ef\u4ee5\u901a\u8fc7\u4eba\u4e3a\u8fdb\u884c\u68c0\u67e5\u3002\u4f46\u6d4b\u8bd5\u6587\u6863\u7684\u76ee\u7684\u662f\u51cf\u8f7b\u4eba\u7c7b\u5ba1\u9605\u8005\u7684\u5ba1\u67e5\u8d1f\u62c5\uff0c\u81ea\u52a8\u5316\u80fd\u8282\u7701\u65f6\u95f4\uff0c\u4ee5\u4fbf\u53ef\u4ee5\u7f16\u5199\uff0c\u53d1\u5e03\u548c\u53d1\u5e03\u66f4\u591a\u6587\u6863\u6587\u4ef6\u3002<\/p>\n

\u94fe\u63a5\u68c0\u67e5<\/h3>\n

\u5bf9\u4e8e\u8bb8\u591a\u9759\u6001\u7ad9\u70b9\u751f\u6210\u5668\uff0c\u6709\u4e13\u95e8\u7528\u4e8e\u68c0\u67e5\u7ad9\u70b9\u4e2d\u6240\u6709\u94fe\u63a5\u7684\u5e93\u3002\u4f8b\u5982\uff0c\u5728\u68c0\u67e5\u50cfdocslikecode.com\u8fd9\u6837\u7684Jekyll\u7f51\u7ad9\u4e0a\u7684\u94fe\u63a5\u65f6\uff0cTravis CI\u5de5\u4f5c\u5f88\u7b80\u5355\uff1a<\/p>\n

#!\/usr\/bin\/env bash<\/em>
\nset -e # halt script on error<\/em>
\nbundle exec jekyll build<\/em>
\nbundle exec htmlproofer .\/_site<\/em><\/p>\n

\u901a\u8fc7\u8fd9\u79cd\u7c7b\u578b\u7684\u6d4b\u8bd5\uff0c\u4eba\u5de5\u5ba1\u9605\u8005\u4e0d\u5fc5\u82b1\u65f6\u95f4\u70b9\u51fb\u65b0\u8865\u4e01\u4e2d\u7684\u6bcf\u4e2a\u94fe\u63a5\u3002\u5982\u679c\u9700\u8981\u66f4\u65b0\u5916\u90e8\u94fe\u63a5\uff0c\u90a3\u4e48\u8fd9\u4e2a\u6d4b\u8bd5\u7684\u7ed3\u679c\u4f1a\u901a\u77e5\u60a8\u3002\u5982\u679c\u5185\u90e8\u94fe\u63a5\u56e0\u4fee\u8865\u7a0b\u5e8f\u672c\u8eab\u800c\u4e2d\u65ad\uff0c\u5219\u7cfb\u7edf\u53ef\u4ee5\u5728\u4eba\u4e3a\u67e5\u770b\u4fee\u8865\u7a0b\u5e8f\u4e4b\u524d\u4fee\u590d\u5b83\u3002<\/p>\n

JSON\u683c\u5f0f<\/h3>\n

\u4f7f\u7528REST API\u6587\u6863\uff0c\u8bf7\u6c42\u548c\u54cd\u5e94\u901a\u5e38\u662fJSON\u6587\u4ef6\uff0c\u5bf9\u4e8e\u9605\u8bfb\u6587\u6863\u7684\u4eba\u5728\u5c06\u81ea\u5df1\u7684\u73af\u5883\u4e0e\u6587\u6863\u8fdb\u884c\u6bd4\u8f83\u65f6\u975e\u5e38\u6709\u4ef7\u503c\u3002\u5728\u8bfb\u8005\u9700\u8981\u590d\u5236\u548c\u7c98\u8d34\u8bf7\u6c42\u7684\u60c5\u51b5\u4e0b\uff0c\u6b63\u786e\u683c\u5f0f\u5316\u793a\u4f8b\u81f3\u5173\u91cd\u8981\u3002\u5728OpenStack\u4e2d\uff0c\u6211\u4eec\u6709\u4e00\u7ec4\u5305\u542bJSON\u6d4b\u8bd5\u5668\u548c\u683c\u5f0f\u5316\u7a0b\u5e8f\u7684\u901a\u7528\u6587\u6863\u5de5\u5177\u3002\u901a\u8fc7\u5bf9\u4f20\u5165\u7684\u4fee\u8865\u7a0b\u5e8f\u5bf9\u6587\u6863\u6587\u4ef6\u8fd0\u884c\u6b64\u6d4b\u8bd5\uff0c\u8bfb\u8005\u53ef\u4ee5\u786e\u5b9a\u6240\u5305\u542b\u7684JSON\u6587\u4ef6\u662f\u5426\u683c\u5f0f\u6b63\u786e\u3002\u6b64\u5916\uff0c\u5f53\u5b83\u4eec\u53ef\u4ee5\u5728\u672c\u5730\u8fd0\u884c\u7b80\u5355\u547d\u4ee4\u4ee5\u786e\u4fddJSON\u683c\u5f0f\u6b63\u786e\u65f6\uff0c\u5b83\u53ef\u4ee5\u4f7f\u8d21\u732e\u8005\u66f4\u5bb9\u6613\u521b\u5efa\u8865\u4e01\u3002<\/p>\n

\u9a8c\u8bc1\u7684\u8bf7\u6c42\u548c\u54cd\u5e94<\/h3>\n

\u9ad8\u7ea7\u6587\u6863\u6d4b\u8bd5\u53ef\u4ee5\u68c0\u67e5\u6587\u6863\u4e2d\u5305\u542b\u7684\u793a\u4f8b\u8bf7\u6c42\u548c\u54cd\u5e94\u3002\u7528\u67e5\u770b\u4ee3\u7801\u6587\u4ef6\u76f8\u540c\u7684\u65b9\u5f0f\u67e5\u770b\u6587\u6863\u6587\u4ef6\u65f6\uff0c\u51c6\u786e\u6027\u901a\u5e38\u662f\u6700\u9ad8\u503c\u3002\u56e0\u6b64\uff0c\u901a\u8fc7\u9488\u5bf9\u6b63\u5e38\u5de5\u4f5c\u7684API\u7aef\u70b9\u6d4b\u8bd5\u793a\u4f8b\uff0c\u60a8\u53ef\u4ee5\u8bc1\u660e\u8fd9\u4e9b\u793a\u4f8b\u4e5f\u9002\u7528\u4e8e\u5b9e\u9645\u60c5\u51b5\u3002\u8fd9\u79cd\u7c7b\u578b\u7684\u9a8c\u8bc1\u63d0\u4f9b\u4e86\u6bcf\u6b21\u90fd\u53ef\u7528\u7684\u6210\u529f\u6587\u6863\u793a\u4f8b\uff0c\u56e0\u4e3a\u53ea\u6709\u5b83\u4eec\u901a\u8fc7\u9a8c\u8bc1\u6d4b\u8bd5\uff0c\u5b83\u4eec\u624d\u88ab\u53d1\u5e03\u3002<\/p>\n

\u5efa\u7acb\u68c0\u67e5<\/h3>\n

\u81ea\u52a8\u5316\u6587\u6863\u6d4b\u8bd5\u53ef\u4ee5\u8282\u7701\u8bfb\u8005\u7684\u65f6\u95f4\uff0c\u56e0\u4e3a\u4ed6\u4eec\u4e0d\u5fc5\u81ea\u5df1\u6784\u5efa\u6587\u6863\u6765\u67e5\u770b\u8f93\u51fa\u3002\u6b64\u5916\u60a8\u53ef\u4ee5\u6d4b\u8bd5\u635f\u574f\u7684\u94fe\u63a5\u6216\u4e0d\u6b63\u786e\u683c\u5f0f\u5316\u7684JSON\u6587\u4ef6\u7684\u6784\u5efa\u3002\u5bf9\u4e8e\u4efb\u4f55\u5947\u602a\u7684\u95ee\u9898\uff0c\u67e5\u770b\u6e90\u6587\u6863\u548c\u8f93\u51fa\u6587\u6863\u90fd\u5f88\u6709\u5e2e\u52a9\u3002<\/p>\n

\u7ed3\u8bba<\/h1>\n

\u5728\u4e0e\u4ee3\u7801\u5e93\u76f8\u540c\u7684\u4ed3\u5e93\u4e2d\u534f\u540c\u5904\u7406\u6587\u6863\uff0c\u53ef\u4ee5\u66f4\u597d\u5730\u4e3a\u5ba2\u6237\u63d0\u4f9b\u670d\u52a1\uff0c\u65e0\u8bba\u4ed6\u4eec\u662f\u7ec4\u7ec7\u7684\u5185\u90e8\u8fd8\u662f\u5916\u90e8\u3002\u901a\u8fc7\u5c06API\u6587\u6863\u89c6\u4e3a\u4ee3\u7801\uff0c\u60a8\u53ef\u4ee5\u627e\u5230\u81ea\u52a8\u5316\u9014\u5f84\uff0c\u63d0\u9ad8\u6548\u7387\uff0c\u52a0\u5feb\u6587\u6863\u6784\u5efa\uff0c\u5728\u6587\u6863\u4e2d\u6784\u5efa\u6210\u529f\u793a\u4f8b\u3002<\/p>\n

 <\/p>\n

\u4f5c\u8005\uff1aAnne Gentle\uff0c\u601d\u79d1\u7684\u6280\u672f\u4ea7\u54c1\u7ecf\u7406\uff1b<\/em><\/p>\n

\u539f\u6587\u6807\u9898\uff1aAlways Be Publishing: Continuous Integration & Collaboration in Code Repositories for REST API Docs\uff1b<\/em><\/p>\n

\u539f\u6587\u5730\u5740\uff1ahttps:\/\/www.infoq.com\/articles\/ci-rest-docs\/?useSponsorshipSuggestions=true\uff1b<\/em><\/p>\n","protected":false},"excerpt":{"rendered":"

\u672c\u6587\u4e3b\u8981\u4ecb\u7ecd\u4ee5\u4e0b\u7684\u5185\u5bb9\uff1aAPI\u6587\u6863\u63d0\u4f9b\u4e86\u9884\u6d4b\u5ba2\u6237\u6210\u529f\u7684\u5173\u952e\u8def\u5f84\uff1b\u5728\u4ee3\u7801\u9644\u8fd1\u7684\u6587\u6863\u4e0a\u8fdb\u884c\u534f\u4f5c\u53ef\u4ee5\u66f4\u597d\u5730\u68c0\u67e5\u4ee3\u7801\u548c […]<\/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\/2422"}],"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=2422"}],"version-history":[{"count":11,"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=\/wp\/v2\/posts\/2422\/revisions"}],"predecessor-version":[{"id":3056,"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=\/wp\/v2\/posts\/2422\/revisions\/3056"}],"wp:attachment":[{"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=2422"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=2422"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/blog.eolinker.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=2422"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}