使用apidoc自动生成接口文档

1.apidoc的使用需借助npm，即你首先需要安装node js

2.然后开始->运行->cmd->npm install apidoc -g 进行全局安装apidoc

可通过apidoc -v 命令查看是否安装成功

3.通过apidoc -f ".*\.java$" -i api/ -o apidoc/ 进行导出操作

ps：注意所有的apidoc命令都是需要在你项目的api目录下通过cmd方式进入到终端进行执行的，且该目录下必须要有apidoc.json文件

关于这个核心配置文件apidoc.json:

配置 
无package.json文件时，需要在代码文件夹的根目录下，创建apidoc.json文件。

{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "title": "Custom apiDoc browser title",
  "url" : "https://api.github.com/v1"
}

在该文件中即可配置apidoc

有package.json文件时，在package.json文件中添加”apidoc”: { }属性即可。

{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "apidoc": {
    "title": "Custom apiDoc browser title",
    "url" : "https://api.github.com/v1"
  }
}

配置属性如下: 
name：项目名称 
version：项目版本 
description：项目介绍 
title：浏览器显示的标题内容 
url：endpoints的前缀，例如https://api.github.com/v1 
sampleUrl：如果设置了，则在api文档中出现一个测试用的from表单 
header 
title：导航文字包含header.md文件 
filename：markdown-file 文件名 
footer 
title：导航文字包含header.md文件 
filename：markdown-file 文件名 
order：用于配置输出 api-names/group-names 排序，在列表中的将按照列表中的顺序排序，不在列表中的名称将自动显示。

@apiParam {参数类型 String、Number、Object} []表示该参数可选