接口文档工具apidoc安装使用

apidoc是一个很方便的用来编写接口文档的工具,可以按照接口描述生成html格式的页面,通过web服务器提供访问,这里介绍apidoc的安装和使用:

1. apidoc的安装包在github网站上,请从github上仓库clone一份安装包到web服务器目录

2. apidoc使用node运行,在使用apidoc前请安装node和node的包管理器npm。node和npm安装完成后,然后进入apidoc安装目录,运行npm install安装依赖软件包

3. 在apidoc安装目录,运行bin/apidoc -h可以看到命令的帮助信息,这样apidoc的安装完成

4. 在apidoc安装目录下再进入example目录,这里是示例文件目录,有一个apidoc.json文件,这是apidoc项目的配置文件,可以配置接口版本,接口地址等信息。在example目录下,运行上一级目录中的bin/apidoc,将生成示例项目的输出文件,输出目录为doc目录

5. 用浏览器访问web服务器的根目录路径,增加上apidoc的访问路径/apidoc/example/doc/,然后可以看到生成的项目页面

你可能感兴趣的:(接口文档工具apidoc安装使用)