文档概述

:green_book:基于 Markdown 编写的接口文档；文档中列出几个案例供参考。

环境部署/安装

本文档在 gitbook 下运行的，安装步骤如下：

1. 克隆源代码

> git clone https://github.com/WongMinHo/api-doc.git

2. 配置本地运行环境

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

浏览器打开：http://localhost:4000/ 即可访问文档。

gitbook 编译成_book静态页面 放入Tomcat webapps/ROOT中直接运行

gitbook build

image.png

首先我们已经用gitbook完成了自己的在线接口文档（一堆静态页面）

然后需要把这些东西部署到服务器上，我们本地可以直接使用idea启动服务，但服务器上不可能给你装idea的，

所以只能利用Tomcat来运行这堆静态文件，对外提供在线接口查询服务。

将应用部署到Tomcat根目录的目的是可以通过“http://[ip]:[port]”直接访问应用，而不是使用“http://[ip]:[port]/[appName]”上下文路径进行访问。

最简单直接的方法

删除原 webapps/ROOT 目录下的所有文件，将_book文件下的所有文件和文件夹复制到ROOT文件夹下。

启动Tomcat访问 http://localhost:8080 哦了！