{"id":185,"date":"2019-08-13T15:10:23","date_gmt":"2019-08-13T07:10:23","guid":{"rendered":"http:\/\/zechs.taipei\/?p=185"},"modified":"2019-08-13T15:12:02","modified_gmt":"2019-08-13T07:12:02","slug":"%e8%bd%89%e5%bf%ab%e9%80%9f%e6%92%b0%e5%af%ab%e5%a5%bd%e7%9c%8b%e7%9a%84-rest-api-%e6%96%87%e4%bb%b6-%e4%bd%bf%e7%94%a8-raml","status":"publish","type":"post","link":"https:\/\/zechs.taipei\/?p=185","title":{"rendered":"[\u8f49]\u5feb\u901f\u64b0\u5beb\u597d\u770b\u7684 REST API \u6587\u4ef6 &#8211; \u4f7f\u7528 RAML"},"content":{"rendered":"<p>\u8f49\u8cbc\u81ea <a href=\"https:\/\/metavige.github.io\/2015\/11\/16\/raml-easy-start-npm\/\">https:\/\/metavige.github.io\/2015\/11\/16\/raml-easy-start-npm\/<\/a> <\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"\u524d\u8a00\">\u524d\u8a00<\/h2>\n\n\n\n<p>\u70ba\u4e86\u8981\u5beb\u4efd\u597d\u770b\u3001\u6613\u61c2\u7684 API \u6587\u4ef6\uff0c\u5982\u679c\u7528\u73fe\u5728\u6bd4\u8f03\u7fd2\u6163\u7684 Markdown \u8a9e\u6cd5\u4f86\u5beb\uff0c\u9084\u9700\u8981\u53bb\u627e\u683c\u5f0f\u8981\u600e\u6a23\u5b9a\u7fa9\u3002<br>\u9019\u5c0d\u5de5\u7a0b\u5e2b\u4f86\u8aaa\uff0c\u5be6\u5728\u662f\u83ab\u5927\u7684\u6298\u78e8\u3002\u8001\u5be6\u8aaa\uff0c\u9019\u6bd4\u8981\u6211\u5beb\u6e2c\u8a66\u6848\u4f8b\u9084\u96e3\uff5e<\/p>\n\n\n\n<p>\u6240\u4ee5\u627e\u4e86\u7db2\u8def\u4e0a\u6709\u95dc REST API \u6587\u4ef6\u898f\u683c\u7684\u8cc7\u6599\uff0c\u627e\u5230\u4e86\u9019\u7bc7\u6587\u7ae0&nbsp;<a href=\"http:\/\/www.programmableweb.com\/news\/why-you-should-use-markdown-your-api-documentation\/2015\/02\/19\" target=\"_blank\" rel=\"noreferrer noopener\">Why You Should Use Markdown for Your API Documentation<\/a><br>\u5176\u4e2d\u63d0\u5230\u4e86&nbsp;<a href=\"http:\/\/raml.org\/\" target=\"_blank\" rel=\"noreferrer noopener\">RAML<\/a>&nbsp;&#8211; RESTful API Modeling Language<\/p>\n\n\n\n<p>\u56e0\u70ba\u6211 API \u662f\u5df2\u7d93\u5beb\u597d\u7684\u72c0\u6cc1\uff0c\u6240\u4ee5\u4e26\u6c92\u6709\u4f7f\u7528\u5230\u5b83\u8207 Source Code \u7d50\u5408\u7684\u90e8\u5206\uff0c\u6240\u4ee5\u53ea\u662f\u55ae\u7d14\u7684\u81ea\u5df1\u6839\u64da\u4e4b\u524d\u5b9a\u7684\u898f\u683c\uff0c\u628a\u6587\u4ef6\u5beb\u51fa\u4f86\uff0c\u4e26\u4e14\u8981\u52a0\u4e0a\u4e00\u4e9b\u7c21\u55ae\u7684\u64cd\u4f5c\u8aaa\u660e<br>\u7576\u7136\u6211\u5e0c\u671b\u9019\u4e9b\u4e5f\u90fd\u662f\u7528 Markdown \u7684\u8a9e\u6cd5\u4f86\u5beb<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"\u958b\u59cb\">\u958b\u59cb<\/h2>\n\n\n\n<p>\u8981\u958b\u59cb\u505a\uff0c\u7576\u7136\u662f\u5148\u770b\u5225\u4eba\u7684\u7bc4\u4f8b\u600e\u9ebc\u505a\uff0c\u76f4\u63a5\u53c3\u8003\uff01<br>\u7531\u65bc\u6211\u5f8c\u7e8c\u8981\u628a\u898f\u683c\u8f49\u63db\u6210\u6587\u4ef6\uff0c\u6240\u4ee5\u6211\u627e\u5230\u4e86&nbsp;<a href=\"https:\/\/github.com\/kevinrenskers\/raml2html\" target=\"_blank\" rel=\"noreferrer noopener\">raml2html<\/a>&nbsp;\u7684\u5de5\u5177\uff0c\u800c\u9019\u500b\u5de5\u5177\u7684 Example \u76f8\u7576\u7684\u8a73\u7d30\uff01\u503c\u5f97\u53c3\u8003<\/p>\n\n\n\n<p>\u63a5\u4e0b\u4f86\uff0c\u4f60\u53ef\u4ee5\u5230&nbsp;<a href=\"http:\/\/raml.org\/developers\/design-your-api\" target=\"_blank\" rel=\"noreferrer noopener\">Design Your API<\/a>&nbsp;\u9019\u500b\u9801\u9762\uff0c\u53bb\u4e0b\u8f09&nbsp;<a href=\"https:\/\/github.com\/mulesoft\/api-designer\" target=\"_blank\" rel=\"noreferrer noopener\">API Designer<\/a><br>\u6709\u88dd npm \u7684\u4eba\u53ef\u4ee5\u76f4\u63a5\u7528\u4ee5\u4e0b\u6307\u4ee4\u5c31\u5b89\u88dd\u597d\u4e86<\/p>\n\n\n<div class=\"wp-block-syntaxhighlighter-code \"><pre class=\"brush: plain; title: ; notranslate\" title=\"\">\nnpm install -g api-designer\n<\/pre><\/div>\n\n\n<p>\u5b89\u88dd\u5b8c\u4e4b\u5f8c\uff0c\u57f7\u884c&nbsp;<code>api-designer<\/code>&nbsp;\u6307\u4ee4\uff0c\u7136\u5f8c\u958b\u555f\u700f\u89bd\u5668\uff0c\u6253\u958b&nbsp;<code>http:\/\/localhost:3000<\/code>\uff0c\u5c31\u53ef\u4ee5\u770b\u5230\u985e\u4f3c\u4e0b\u9762\u7684\u756b\u9762\u4e86\uff01<\/p>\n\n\n\n<figure class=\"wp-block-image\"><a href=\"https:\/\/metavige.github.io\/2015\/11\/16\/raml-easy-start-npm\/api_designer_web.png\"><img decoding=\"async\" src=\"https:\/\/metavige.github.io\/2015\/11\/16\/raml-easy-start-npm\/api_designer_web.png\" alt=\"\"\/><\/a><\/figure>\n\n\n\n<p>\u900f\u904e\u9019\u500b Api Designer \u7684 UI\uff0c\u53ef\u4ee5\u5f88\u7c21\u55ae\u7684\u770b\u51fa\u4f60\u7de8\u8f2f\u7684 RAML \u683c\u5f0f\u662f\u5426\u6b63\u78ba\uff0c\u5982\u679c\u4e0d\u6b63\u78ba\uff0c\u9019\u500b UI \u5c31\u6703\u63d0\u9192\u4f60\u932f\u8aa4\u767c\u751f\u7684\u5730\u65b9\uff0c\u4e26\u4e14\u5728\u4f60\u7de8\u8f2f\u5b8c\u5f8c\u53ef\u4ee5\u76f4\u63a5\u9810\u89bd\uff5e<br>(\u9019\u908a\u4e0d\u4ecb\u7d39\u9019\u500b UI \u7684\u4f7f\u7528\uff5e\uff5e\uff5e)<\/p>\n\n\n\n<p>\u66f4\u65b0\uff1a<br>\u6839\u64da&nbsp;<a href=\"https:\/\/github.com\/mulesoft\/api-designer\/blob\/master\/docs\/file-system.md\" target=\"_blank\" rel=\"noreferrer noopener\">Editor File System<\/a>&nbsp;\u9019\u4efd\u6587\u4ef6\u8aaa\u7684\uff0c\u4ee5\u53ca\u770b\u4e86\u4e00\u4e0b\u6211\u81ea\u5df1\u700f\u89bd\u5668\u7684\u8a2d\u5b9a\uff0c\u624d\u767c\u73fe\uff0c\u9019\u500b api designer \u662f\u628a\u8cc7\u6599\u5b58\u5728 LocalStorage \u4e2d<br>\u6240\u4ee5\uff0c\u5b83\u4e26\u4e0d\u662f\u628a\u8cc7\u6599\u5b58\u5728 server \u7aef\u3002<\/p>\n\n\n\n<p>\u9019\u6709\u500b\u597d\u8655\u662f\uff0c\u5927\u5bb6\u53ef\u4ee5\u5171\u7528\u540c\u6a23\u7684 api designer UI \u4f86\u7de8\u8f2f\u81ea\u5df1\u7684\u6587\u4ef6\u683c\u5f0f\uff0c\u4e0d\u7528\u64d4\u5fc3\u6703\u88ab\u5225\u4eba\u6539\u5230<br>\u4e0d\u904e\u58de\u8655\u4e5f\u662f\u4e00\u6a23\uff0c\u5225\u4eba\u7121\u6cd5\u7de8\u8f2f\uff5e<\/p>\n\n\n\n<p>\u4e0d\u904e\uff0c\u6839\u64da\u9019\u500b\u597d\u8655\uff0c\u8868\u793a\u5176\u5be6\u6211\u53ef\u4ee5\u5f88\u5b89\u5fc3\u7684\u81ea\u5df1\u505a\u4e00\u500b docker image<br>\u9019\u6a23\u65b9\u4fbf\u5176\u4ed6\u4eba\u4f7f\u7528<\/p>\n\n\n\n<p>\u6709\u9700\u8981\u7684\u4eba\u53ef\u4ee5\u81ea\u5df1\u4e0b\u8f09\uff5e (\u56e0\u70ba\u662f\u7528 alpine \u70ba base\uff0c\u6240\u4ee5\u53ea\u6709 48.86 MB)<br><a href=\"https:\/\/metavige.github.io\/2015\/11\/16\/raml-easy-start-npm\/\">https:\/\/github.com\/metavige\/alpine-api-designer<\/a><\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"\u8f49\u63db-HTML\">\u8f49\u63db HTML<\/h2>\n\n\n\n<p>\u5beb\u5b8c&nbsp;<a href=\"http:\/\/raml.org\/\" target=\"_blank\" rel=\"noreferrer noopener\">RAML<\/a>&nbsp;\u4e4b\u5f8c\u9084\u662f\u9700\u8981\u8f49\u63db\u6210 HTML \u624d\u597d\u770b\uff0c\u6240\u4ee5\u900f\u904e&nbsp;<a href=\"https:\/\/github.com\/kevinrenskers\/raml2html\" target=\"_blank\" rel=\"noreferrer noopener\">raml2html<\/a>&nbsp;\u5de5\u5177\uff0c\u5148\u7528 npm \u5b89\u88dd\uff1a<\/p>\n\n\n<div class=\"wp-block-syntaxhighlighter-code \"><pre class=\"brush: plain; title: ; notranslate\" title=\"\">\nnpm i -g raml2html\n<\/pre><\/div>\n\n\n<p>\u7136\u5f8c\u900f\u904e\u6307\u4ee4\u53bb\u8f49\u63db\uff1a<\/p>\n\n\n<div class=\"wp-block-syntaxhighlighter-code \"><pre class=\"brush: plain; title: ; notranslate\" title=\"\">\nraml2html -i example.raml -o example.html\n<\/pre><\/div>\n\n\n<p>\u5982\u679c\u4f60\u5beb\u7684\u5f88\u8c50\u5bcc\uff0c\u7d50\u679c\u53ef\u80fd\u5c31\u6703\u50cf\u662f raml2html \u7684\u7bc4\u4f8b\u4e00\u6a23<\/p>\n\n\n\n<figure class=\"wp-block-image\"><a href=\"https:\/\/metavige.github.io\/2015\/11\/16\/raml-easy-start-npm\/example.png\"><img decoding=\"async\" src=\"https:\/\/metavige.github.io\/2015\/11\/16\/raml-easy-start-npm\/example.png\" alt=\"Example\"\/><\/a><\/figure>\n\n\n\n<p>Example<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"\u7d50\u8a9e\">\u7d50\u8a9e<\/h2>\n\n\n\n<p>\u73fe\u5728\u6211\u81ea\u5df1\u4f7f\u7528\u9084\u6709\u9047\u5230\u4e00\u4e9b\u554f\u984c\uff0c\u4e0d\u904e\uff0c\u6574\u9ad4\u4f86\u8aaa\uff0c\u7522\u51fa\u7684\u5167\u5bb9\u6211\u81ea\u5df1\u662f\u9084\u883b\u6eff\u610f\u7684<br>\u683c\u5f0f\u4e5f\u7b97\u4e0d\u96e3\u770b\uff0c\u7576\u7136\uff0c\u6587\u4ef6\u5167\u5bb9\u672c\u8eab\u9084\u9700\u8981\u50b7\u8166\u7b4b\u4e00\u4e0b\uff0c\u7562\u7adf\u6587\u4ef6\u662f\u8981\u7d66\u4eba\u770b\u7684\uff0c\u5167\u5bb9\u90e8\u5206\u5176\u5be6\u9084\u883b\u91cd\u8981\u7684\uff01<\/p>\n\n\n\n<p>\u76ee\u524d\u6211\u4f7f\u7528\u7684\u662f RAML 0.8 \u7684\u7248\u672c\uff0c\u6211\u60f3\u61c9\u8a72\u5c31\u5920\u4e86 \u56e0\u70ba RAML 1.0 \u597d\u50cf\u662f\u65b0\u7684\uff0c\u4e0d\u77e5\u9053\u65b0\u7684\u6703\u4e0d\u6703\u6709\u4ec0\u9ebc\u554f\u984c\uff0c\u6211\u4e5f\u6c92\u591a\u52a0\u7814\u7a76<\/p>\n\n\n\n<p>\u4e4b\u5f8c\u7b49\u5230\u6587\u4ef6\u5167\u5bb9\u90fd\u5beb\u5b8c\u4e86\uff0c\u518d\u4f86\u7814\u7a76\u81ea\u52d5\u5316\u7684\u90e8\u4efd\u4ee5\u53ca\u65b0\u7684 RAML 1.0 \u898f\u683c\uff0c\u50cf\u662f\u4e0d\u662f\u53ef\u4ee5\u7d50\u5408 CI (Jenkins) ?<\/p>","protected":false},"excerpt":{"rendered":"<p>\u8f49\u8cbc\u81ea https:\/\/metavige.github.io\/2015\/11\/16\/raml-easy-sta &#8230; <a title=\"[\u8f49]\u5feb\u901f\u64b0\u5beb\u597d\u770b\u7684 REST API \u6587\u4ef6 &#8211; \u4f7f\u7528 RAML\" class=\"read-more\" href=\"https:\/\/zechs.taipei\/?p=185\" aria-label=\"\u95b1\u8b80\u3008[\u8f49]\u5feb\u901f\u64b0\u5beb\u597d\u770b\u7684 REST API \u6587\u4ef6 &#8211; \u4f7f\u7528 RAML\u3009\u5168\u6587\">\u95b1\u8b80\u5168\u6587<\/a><\/p>","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4],"tags":[],"class_list":["post-185","post","type-post","status-publish","format-standard","hentry","category-tech"],"_links":{"self":[{"href":"https:\/\/zechs.taipei\/index.php?rest_route=\/wp\/v2\/posts\/185","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/zechs.taipei\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/zechs.taipei\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/zechs.taipei\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/zechs.taipei\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=185"}],"version-history":[{"count":2,"href":"https:\/\/zechs.taipei\/index.php?rest_route=\/wp\/v2\/posts\/185\/revisions"}],"predecessor-version":[{"id":187,"href":"https:\/\/zechs.taipei\/index.php?rest_route=\/wp\/v2\/posts\/185\/revisions\/187"}],"wp:attachment":[{"href":"https:\/\/zechs.taipei\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=185"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/zechs.taipei\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=185"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/zechs.taipei\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=185"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}