移动梦工场Mstore标准产品接口规范.docxVIP

移动梦工场Mstore标准产品接口规范文档控制变更记录日期作者版本变更描述2016-6-14吴标洋V1.0初版接口规范文档MODULE目录是现有的三端所调用的接口目录，实现了改一个文件，三端同时修改，因为一改三端都同步改动，开发的时候需要特别细心，否则后果严重。1.在该目录开发一个接口，需要做成三端兼容，可以用$this-is_web_platform(),$this-get_platform() 进行做兼容，$this-is_web_platform() 是pc和wap端$this-get_platform() 获得site,wap,mobile,参数$this-get_platform(true) 获得1,2参数 1：代表pc,2:手机端2.module每个开发一个类，需要用简单明了的意思为该类命名，文件的头部需要注释下该类的用途。3.module里的一个类新增一个方法，需要注释，也记得标名该类是，私有的 ，公开的，还是不公开可继承的。4.控制器调用module的方法为$this-api(‘module’),该方法可以解决以前跨控制器调用方法出问题。5.module类里的只做提示，不是显示数据方法返回值（return） 必须用指定的函数，$this-api_error(‘code’,’msg’, $data), $this-api_success(‘msg’,$data),如商品详情页和商品列表页这样直接返回数据的可以直接return 数组.6.模板的制作绝不允许出现复杂得逻辑判断。只能出现判断值是否为空，货值值为1.绝不能出现（status == 1 || status == 2 || status == 3 || status == 5 || status == 6）这样的复杂判断。7.module里返回的数据必需是模板需要的值，多余都不需要返回，特别比较隐私的数据，决不允许返回。8.module里的方法使用的getList的方法时不能使用*做为字段。9.module里的方法尽量少出现url链接，$_POST,$_GET这些字段，传进来的值有些有安全隐患的，必需处理后，再扔到模板显示，否则会出现漏洞。还有图片需要进行转换号，再返回出来。10.module里的方法常用方法列表$this-cur_odr()//格式化价格$11.00$this-cur_odr()//格式化价格$11.00$this-gen_url()//适配三端链接$this-get_pager($count,$limit,$page,$url,$pagetotal)//分页信息$this-getMemberInfo()//获取会员资料mobile接口规范 module返回的是数组，没有code,msg字段的数组，需要缓存的数据就使用$this-page(),否则使用$this-echo_json();每个接口的分页请使用$_POST[‘page’],不能使用其他，比如page_no , nPage 都是不对的。 单个接口数据量太大，请拆分成异步的形式请求接口$this-error_api($code,$msg)规范$code,就是错误代码值，请勿使用’error’做 code,这样无法识别哪里出错。列: $code = ‘need_login’, 请登录的意思，现有的code值……../…..2