项目开发规范

开发规范

IDE

大家在开发过程中尽量使用PHPStorm工具,有利于减少沟通以及IDE不同造成的误差。

 

代码开发

 

注释规范

注释是编程中重要的一部分、以PHPDoc的规范为标准、便利于直接生成技术文档。

 

 

接口规范

功能分为两大部分:搜索功能和问答功能

使用接口方式、也就是后台开发中共用统一提供APP和前端一套接口

接口统一使用JSON格式返回、如:

[

    {

        “created_at” : “Tue Nov 30 14:34:35 +0800 2010”,

        “text” : “吃力不讨好的事情我是坚决不会再做了,RI你个仙人!发飙~~~~我只想说档次和素质在那里去了,你也就只能在这种地方混!“,

        “truncated” : false,

        “in_reply_to_status_id” : “”,

    },

]

 

格式的定义如下表所示:

项目

说明

API

get_cs_address.php

URL

http://rootcs.freepp.com/rootcs/2.0/get_cs_address.php

Param

 

POST提交。

l mobile: 本机的Mobile号码,E.164格式(必填)

l cc: 国码,不带加号(非必填)

注:cc为非必填项。

Error Code

(操作失败)

22000:系统维护中(此时,一并返回 pmsid=1),客户端停止后续的注册动作。

22002:非法的E.164号码(没有以+开头)

22999:参数错误

Return

(操作成功)

返回值类似CS的返回值格式,为多行的key=value格式。

l cs: 分配的CS地址,可以是ip地址,也可以是域名。

l otherreg:是否采用纯语音认证。0:否;1:是。

注:otherreg参数,在最新版本中,已经被废弃。

 

该文档也由同时开发人员共同维护维护。

错误代码说明

错误码格式为:

{

“error” : “20502”,

“msg” : “Need you follow uid.”

}

 

错误代码的具体规范:

错误代码分为两种:

系统级错误:表示系统级别的错误如系统错误、GET请求的参数超长等。具体规范是由10开头的共5位数字、如1000110002、末尾数字1开始逐渐自增。如下图所示

 

系统级错误

 

另外一种是服务级错误、表示具体某项业务中发生的错误。具体规范是由20开头的共5位数字、如2000120102。第三位表示具体的业务类型。0为基础类型、表示业务中一些基本用到的错误如用户不存在、图片过大等。假设1可以为问答、如问题不存在这样的内容。

 

 

服务级错误

 

错误代码文档由所有开发人员共同维护、当增加错误代码时增加在编码处并进行更新,让所有开发人员获知。

发表评论

电子邮件地址不会被公开。


*