错误代码定义
用于定义接口服务程序中所用到的错误代码
全局错误代码定义
错误代码描述定义
全局错误代码定义
error_needlogin:1098; // 需要登录后才能访问 error_needauth: 1099; // 需要特定权限 error_needrole: 1100; // 需要特定身份 error_noparam : 1101; // 没有参数 error_db : 1103; // 数据库存取出错 error_sign : 1104; // 参数签名错 error_pagesize: 1105; // 分页大小错,不在设置允许的分页大小范围内 error_invalidreq: 1106; // 无效请求 error_unknown : 1107; // 其他未知错误
指定的错误代码要在错误代码定义中存在,否则生成的代码编译时会报缺少定义的错。
错误代码定义描述
放在定义文件中
error_codes : [ // NAME=>array(CODE,DESC[,HTTPCODE,HTTPSTATUS]) 'API_NEED_ROLE' => array(1100, '缺少权限',403,'Forbidden'), 'API_NOPARAM' => array(1101, '缺少参数'), ];
放在定义文件外,可以是在csv,xls文件中,也可以是存在mysql数据库的一张表中,通过file_type指定
当为mysql时,sql_conn和sql_query起作用,描述数据的库连接和选择数据的sql
当为文件类型时,则需要通过col_name,col_code,col_desc,col_httpcode,col_httpstatus指定相关信息所在的列
当为xls文件类型时,可以通过sheet_idx,sheet_name来指定要用哪一个页的定义数据,两个值都设置时优先使用sheet_name的设置值,不设置默认取第一页的数据
error_codes_ext :[ sql_conn : "server=127.0.0.1,username=root,password=,database=error_codes"; sql_query: "select 'name' as codename, 'value' as code, 'message' as codedesc, httpstatus from api_errorcodes"; file_name : "..\errorcodes.csv"; file_type : mysql; // csv, xls 或 mysql sheet_idx : 1; sheet_name: "账号错误代码"; skip_line : 1; col_name : 3; col_code : 4; col_desc : 5; col_httpcode:6; col_httpstatus:7; code_heads: "100,900"; // 错误代码的前缀,用逗号分隔,用于只将本接口服务需要的错误代码引入 ]