RAML文档展示

raml的文档展示有两个较流行的工具

• API Console
• RAML to HTML

两个均试用过,RAML to HTML的展示是比较人性化的
以下采用RAML to HTML工具进行试验

使用方法

npm i -g raml2html
raml2html api.raml > api.html

生成html文件

打开api.html文件后如图:

微信截图_20170212094241.png

每一项是可以展开的,如图:

微信截图_20170212094254.png

单击GET或POST方法,可以打开详情,如图:

微信截图_20170212094322.png

上图展示了api接口的请求参数,下面展示下返回数据详情:

微信截图_20170212094345.png

---

未完待续......