snowboard快速生成api文档

snowboard快速生成api文档。作为接口文档最合适不过了。网上关于这方面的介绍不多,自己写下,算是一个笔记,对他人来说是福利。下面是我研究学习的。希望对你有好处。
要看英文文档,https://github.com/bukalapak/snowboard
1,下载。我用下面的命令没有成功,可以是被墙的原因。直接跟别人要了一个安装上了,如果需要,可以私信我。

brew install snowboard

2,安装

./snowboard
sudo cp snowboard /usr/local/bin

3,查看是否安装完成

snowboard

4,直接利用snowboard生成文档

snowboard html -o output.html -s API.apib

浏览器打开127.0.0.1:8088即可查看

5,也可以使用自定义的模板来生成文档,作者给的自定义文档,可以在这个基础上修改
https://github.com/bukalapak/snowboard/blob/master/templates/alpha.html
命令为:

 snowboard html -o output.html -t alpha.html -s API.apib
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小~小

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值