apidoc

{
  "name": "青蛙快车",
  "version": "1.0.0",
  "description": "青蛙快车开发接口文档",
  "title": "青蛙快车",
  "url" : "http://www.dunheic.com:8080",
  "order": [
    "Error",
    "Define",
    "PostTitleAndError",
    "PostError"
  ]
}

/**
 * @apiDefine UserNotFoundError
 *
 *
 *
 * @apiErrorExample 响应码
 *     成功
 *     {
 *       "code": "200"
 *     }
 *
 *     未知错误
 *     {
 *       "code": "400"
 *     }
 *
 *     未登录
 *     {
 *       "code": "100"
 *     }
 *
 *     失败
 *     {
 *       "code": "300"
 *     }
 *
 *     参数错误
 *     {
 *       "code": "500"
 *     }
 */


 /**
  *  @api {post} /login login
  *  @apiName login
  *  @apiGroup User
  *  @apiDescription 这是登录接口
  *  @apiParam (请求参数) {String} tel  手机号码（必填）
  *  @apiParam (请求参数){String} password  密码（必填）
  *
  *  @apiSuccess (成功 200) {String} tel 手机号
  *  @apiSuccess (成功 200) {String} token 令牌
  *  @apiVersion 1.0.0
  *
  *  @apiUse UserNotFoundError
  */

 /**
  *  @api {post} /sign sign
  *  @apiName sign
  *  @apiGroup User
  *  @apiDescription 这是注册接口
  *  @apiParam (请求参数) {String} tel  手机号码（必填）
  *  @apiParam (请求参数){String} password  密码（必填）
  *  @apiParam (请求参数){String} code  验证码（必填）
  *
  *  @apiVersion 1.0.0
  *
  *  @apiUse UserNotFoundError
  */

/**
 *  @api {post} /getCode getCode
 *  @apiName getCode
 *  @apiGroup User
 *  @apiDescription 获取短信验证码
 *
 *  @apiVersion 1.0.0
 *
 *  @apiUse UserNotFoundError
 */


/**
 *  @api {post} /forget_password forget_password
 *  @apiName forget_password
 *  @apiGroup User
 *  @apiDescription 忘记密码
 *
 *  @apiParam (请求参数) {String} tel  手机号码（必填）
 *  @apiParam (请求参数){String} old_password  旧密码（必填）
 *  @apiParam (请求参数){String} new_password  新密码（必填）
 *  @apiParam (请求参数){String} code  验证码（必填）
 *
 *  @apiVersion 1.0.0
 *
 *  @apiUse UserNotFoundError
 */

apidoc -i src/ -o qingwakuaiche //编译命令