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