1. 程式人生 > >snowboard快速生成api文件

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