api接口规范 - 开发交流区

##### api接口规范
1. 文件在application\api2\controller下创建Api接口文件
2. 一个文件为一个模块，文件名为第一个为大写字母，其余为小写
3. 要install.php,upgrade.php里添加模板API的SQL语句
```php
INSERT INTO `{$tablename}_apigroup` VALUES ('1', '购物币', 0);
```
```php
INSERT INTO `{$tablename}_apiitem` ('1', '获取列表', '0', '1', 'coins', 'getlist');
```

##### 文档规范
1. api接口通过注释来生成API文档
2. 范例
```php
 /**
     * @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
     */
```

#### 签名算法
```php
//除action不参与签名
function getSignature($secret,$params)
{
    $str = '';  //待签名字符串
    //先将参数以其参数名的字典序升序进行排序
    ksort($params);
    //遍历排序后的参数数组中的每一个key/value对
    foreach ($params as $k => $v) {
        //为key/value对生成一个key=value格式的字符串，并拼接到待签名字符串后面
       if(is_array($v) || is_object($v)){
           $str .= $k.json_encode($v);
       }else{
           $str .= $k . $v;
       }

}
    //将签名密钥拼接到签名字符串最后面
    $str .= $secret;
    //通过md5算法为签名字符串生成一个小写的md5签名，该签名就是我们要追加的sign参数值
    return strtolower(md5($str));
}
```