📗基于 Markdown 编写的接口文档;文档中列出几个案例供参考。
本文档在 gitbook 下运行的,安装步骤如下:
> git clone https://github.com/WongMinHo/api-doc.git
1). 安装npm 从官网下载源码,解压,执行如下命令安装:
./configure
make
make install
2). 安装gitbook
npm install gitbook-cli -g
如果安装太慢,可以设置淘宝代理镜像,执行命令:
npm config set registry https://registry.npm.taobao.or
查看gitbook是否安装成功:
gitbook -V
进入api-doc目录,执行命令:
gitbook serve
浏览器打开:https://localhost:4000/ 即可访问文档。