http://apidocjs.com/
Example:
Mycode.java under the MyApp directory
/** * * * @api {get}/company/list get company info * @apiName get company list * @apiGroup all * @apiVersion 0.1.0 * @apiDescription Interface Details * * @apiParam {int} pagenum paging Size * * @apiSuccess {string} code result code * @apiSuccess {string} MSG message Description * @apiSuccess {Object} da TA Paging Data package * @apiSuccess {int} data.count Total records * @apiSuccess {object[]} data.list pagination data Object array * @apiSuccessExample Success-res Ponse: * http/1.1 OK * {* code:0, * msg: ' Success ', * data:{} *} * * @apiError all corresponds to <CODE>ID< ;/code> user did not find ASDFASDF * @apiErrorExample {JSON} error-response: * http/1.1 404 Not Found * {* code:1, * Msg: ' User not found ', *} * * @param param * @return * @throws Exception*/@Deprecated Public InterfaceMyCode {voida ();}
Generating HTML documents
Apidoc-i myapp/-O apidoc/
Apidoc, a pretty good document generator