raml转换为html,js,markdown

本文介绍如何使用node.js工具Raml2html和Raml2md将RAML接口设计文件转换为HTML和Markdown格式的文档,并提供了Ramljavascript生成器的使用方法。

通过raml将接口设计完成后,我们需要提供简洁可读的直观视图和说明文档。
这里我们通过node.js来实现转换

Raml2html

官方地址

raml版本支持

raml2html 4和更高的版本仅支持raml 1.0语法转换,对于raml 0.8语法,需要使用raml2html的3.x版本

安装

npm i -g raml2html

使用

raml2html –help
raml2html example.raml > example.html

Raml2md

官方地址

raml版本支持

raml2html 4和更高的版本仅支持raml 1.0语法转换,对于raml 0.8语法,需要使用raml2html的3.x版本

安装

npm i -g raml2md

使用

raml2md example.raml > example.md
raml2md -i example.raml -o example.md

以上两种方式都可以实现

Raml javascript 生成器

官方地址

安装

npm install raml-client-generator -g

使用

raml-to-client api.raml -o api-client -l javascript

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值