apidoc

自动生成api文档是基于apidoc实现的，具体安装方式请参考

apidoc.json配置：

{
	"name": "webside api doc",
	"version": "1.0.0",
	"description": "webside Attentively, professionally, free and open source",
	"title": "webside api doc",
	"url": "http://127.0.0.1:8080/webside/",
	"forceLanguage": "zh-cn",
	"template": 
	{
		"withCompare": true,
		"withGenerator": true
	}
}

apidoc 模板：

/**
 * @api {post} / B实名认证-b申请、修改企业认证 corp.update
 * @apiVersion 0.1.0
 * @apiName corp.update
 * @apiGroup 1USER
 * @apiPermission 主账号
 *
 * @apiDescription 该接口用于提交、修改会员认证申请
 *
 * @apiExample 使用样例:
 * curl -i http://120.24.213.22:1006/v1
 *
 * @apiParam {String}     api_token    token
 * @apiParam {Number}     audit_type        认证类型:1代表供应商,2代表服务商，3代表采购商(个人),4代表采购商(企业)
 * @apiParam {Number}     person_name       个：真实姓名
 * @apiParam {Number}     id_no             个：身份证号码
 * @apiParam {Number}     id_pic            个：身份证复印件
 * @apiParam {String}     company_name      企：公司名称
 * @apiParam {String}     company_name_en   企：公司名称(英)
 * @apiParam {String}     reg_code          企：纳税人识别号
 * @apiParam {String}     [address]           企：注册场所地址
 * @apiParam {String}     [telephone]         企：注册固定电话
 * @apiParam {String}     contacter         联系人
 * @apiParam {String}     mobilephone       联系手机(默认为注册手机号, 可修改)
 * @apiParam {String}     [email]           联系邮箱(默认为注册邮箱, 可修改)
 * @apiParam {String}     bank              企：基本开户银行名称
 * @apiParam {String}     account           企：基本开户账号
 * @apiParam {String}     reg_pic          企：税务登记复印件
 * @apiParam {String}     business_pic      企：营业执照复印件
 * @apiParam {String}     general_pic       企：一般纳税人复印件
 * @apiParam {String}     has_export       企：是否有出口资质
 * @apiParam {String}     export_pic       企：出口资质证明(有资质时，必须上传)
 * @apiParam {String}     price_ability     企：国际报价能力(无资质时可选，有资质时默认为有国际报价能力)
 *
 * @apiSuccess {Number}   apply_id          认证申请记录ID
 *
 * @apiParamExample {json} Request-example
 *
 * @apiErrorExample Error-Response:
 *
 * @apiSuccessExample Success-Response:
 *
 */

apidoc使用说明：

1.将apidoc.json文件放到需生成文档的项目的更目录,比如 src/下

2.在项目根目录下，执行命令

apidoc -i 源文件路径 -o 文档生成目标路径

demo： apidoc -i src/ -o src/main/webapp/apidoc/