django的apidoc使用,拥有自己的api文档

一、使用步骤

1、安装apidoc，需要安装node哦

npm install apidoc -g

2、写文档文件

文档文件是java的文件，格式如下，xx.java

/**
 * @api {post} /taskjdb/createissue/ 获取用户信息接口
 * @apiName GetUser
 * @apiGroup 新版流程工单
 *
 * @apiParam {String} qnumber 问题编号
 * @apiParam {String} qtitle 标题
 * @apiParam {Number} issuetype 工单类型
 *
 * @apiSuccess {Boolean} issuc 返回结果标识
 * @apiSuccess {String} msg  返回结果描述
 *
 * @apiSuccessExample Success-Response:
 *     HTTP/1.1 200 OK
 *     {
 *       "issuc": True,
 *       "results": {}
 *     }
 *
 * @apiError UserNotFound The id of the User was not found.
 *
 * @apiErrorExample Error-Response:
 *     HTTP/1.1 404 Not Found
 *     {
 *       "error": "UserNotFound"
 *     }
 */

注意：根目录需要加apidoc.json配置文件

{
    "name": "建造平台api文档",
    "version": "1.0.0",
    "de