api接口规范

2022-12-07 18:35:30 阅读:2 编辑
api接口规范
  1. 文件在application\api2\controller下创建Api接口文件
  2. 一个文件为一个模块,文件名为第一个为大写字母,其余为小写
  3. 要install.php,upgrade.php里添加模板API的SQL语句
    INSERT INTO `{$tablename}_apigroup` VALUES ('1', '购物币', 0);
    INSERT INTO `{$tablename}_apiitem` ('1', '获取列表', '0', '1', 'coins', 'getlist');
文档规范
  1. api接口通过注释来生成API文档
  2. 范例
    /**
     * @api {post} ?action=coins_getList
     * @apiDescription 获取购物币列表
     * @apiGroup 购物币
     * @apiVersion 1.0.0
     * @apiUse api_base_param
     * @apiParam {String} user_id 用户
     * @apiUse api_base_success
     * @apiUse api_error
     */