Apidoc, a pretty good document generator

Source: Internet
Author: User


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

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.