apidoc是一个轻量级的在线REST接口文档生成系统，撑持多种主流语言，包孕Java、C、C#、PHP和等。使用者仅需要凭据要求书写相存眷释，就可以生成可读性好、界面美不雅观的在线接口文档。本文主要包罗以下内容：
介绍apidoc的根基观点
安置、使用和简单配置
一些特殊参数的含义及其使用
介绍一些使用经验
前言 apidoc能做什么apidoc是一个轻量级的在线REST接口文档生成系统，可以按照其特定的法则的代码注释来生成静态网页。首先看下它生成的文档界面和气势派头。
撑持apidoc撑持多种主流的编码语言，包孕Java、C、C#、php和。一般情况下，语言会有多种注释要领，例如就Java中有普通气势派头的多行注释和Javadoc气势派头的注释。apidoc并不撑持所有的注释，譬如Java仅中撑持Javadoc气势派头的注释。首先要说明的是，apidoc并不具备语义识别能力，它不会发明代码中是否有BUG，它仅仅通过文件后缀来判断语言类型。下面是一些差别语言注释示例：
* Java、Javascript、PHP * /** * @api {get} /user/:id Request User information * @apiName GetUser * @apiGroup User * * @apiParam {Number} id Users unique ID. * * @apiSuccess {String} firstname Firstname of the User. * @apiSuccess {String} lastname Lastname of the User. */ * Python * """ @api {get} /user/:id Request User information @apiName GetUser @apiGroup User @apiParam {Number} id Users unique ID. @apiSuccess {String} firstname Firstname of the User. @apiSuccess {String} lastname Lastname of the User. """
安置
apidoc是基于nodeJs平台，在安置apidoc之前，需要先安置nodeJs。关于nodeJs的安置，一搜一大把，不过为了文章的完整性，还是首先介绍一下Windows平台下nodeJs的安置。nodeJs安置
首先，去node.js官网上下载最新的安置包，请下载本身对应系统的安置包。譬如笔者的操纵系统是64位Windows操纵系统，就下载下图所示的node安置包。
下载完毕后，凭据一般的软件安置法式安置即可。由于笔者的计算机已经安置过了，在这里就不过细演示了。
按理来说，凭据安置法式安置完毕后，node环境也已经配置好了，此刻来验证一下node是否已正确安置配置。
首先，打开Window Shell窗口。使用win+R快捷键打开运行窗口，在文本框中输入cmd并回车打开Windows Shell。
然后，在控制台输入node命令进入node控制台。
最后，运行一个Hello World措施。在node控制台中输入console.info("hello world");，如果输出如下图所示的功效，则暗示node安置配置告成。
除了node之外，npm（node package manager，node安置承打点器）也是很重要的，可以通过它来便捷地下载和安置node应用。在Windows Shell中输入npm命令，如果呈现如下图所示的信息，则暗示npm也正确安置完毕。
apidoc安置apidoc可以操作npm来快速安置。
1、进入Windows Shell，输入npm install apidoc -g进行apidoc的安置，如下图。
期待一按时间（按照自身的网速）的下载和安置之后，如果呈现下图所示的信息，则暗示apidoc安置告成。
2、在Windows Shell中输入apidoc -v命令，如果呈现如下图所示的界面，则暗示apidoc已安置告成。
下面通过一些简单的demo来介绍如何操作apidoc生成一份在线接口文档。
命令行在正式开始之前，先介绍一下apidoc中的重要命令和参数。apidoc的命令格局如下：
apidoc 参数