二、出参规范:
1.查询:
返回参数统一按如下接口形式,其中cnt为ad在数据库中的总数目,如下面数据,ad下的list总数为2,area下的list总数为3。当接口有错误返回时,code大于1,且msg中含有错误信息,当无错误时,code为1,且msg为空。
当接口传入当前页参数p ,当前页数据条数ps时,接口返回时,同样也会反给客户端p与ps参数。
如果有极端情况,即同一接口返回多个list,则接口分页入参定义为“p+下划线+当前list的下标”,如下接口,ad下的list中,当前页的输入参数为p_ad,ad的每页条数输入参数为ps_ad,即post或get中分页参数为p_ad=1&ps_ad=20&p_area=1&ps_area=20
cnt不是当前list返回的条数,而是数据库中,该list的总条数,用于分页。
json格式示例:
{
“code”:1,
“msg”:“”,
“ad”:{
“cnt”:22,
“p”:2,
“ps”:20,
“list”:[{
“adv_title”:“\u8fd9\u662f\u5e7f\u544a\u6807\u98981”,
“adv_link”:“m.xxxxxx.cn\/advert\/tbsync\/”,
“open_target”:“2”,
“img_url”:“www.xxxxxx.cn\\\/data\\\/upload\\\/shop\\\/adv\\\/04825861373036910.png”
},
{
“adv_title”:“\u8fd9\u662f\u5e7f\u544a\u6807\u98982”,
“adv_link”:“m.xxxxxx.cn\\\/advert\\\/newerDerate\\\/?430”,
“open_target”:“2”,
“img_url”:“www.xxxxxx.cn\\\/data\\\/upload\\\/shop\\\/adv\\\/04782825931526321.png”
}
]
},
“area”:{
“cnt”:3,
“p”:1,
“ps”:20,
“list”:[{
“c_area_id”:“16”,“c_area_name”:“\u6df1\u5733”,
“c_area_pic”:“04732773115385188.jpg”,
“english_name”:“shenzhen”,“goodsCount”:“21”,
“img_url”:“www.xxxxxx.cn\\\/data\\\/upload\\\/shop\\\/adv\\\/04825861373036910.png”
},
{
“c_area_id”:“18”,
“c_area_name”:“\u6e56\u5357”,
“c_area_pic”:“04732773115385188.jpg”,
“english_name”:“hunan”,
“goodsCount”:“33”,
“img_url”:“www.xxxxxx.cn\/data\/upload\/shop\/adv\/04825861373036910.png”
},
{
“c_area_id”:“2”,
“c_area_name”:“\u5317\u4eac”,
“c_area_pic”:“04732773115385188.jpg”,
“english_name”:“beijing”,“goodsCount”:“70”,
“img_url”:“www.xxxxxx.cn\/data\/upload\/shop\/adv\/04825861373036910.png”
}
]
},
“goods_info”:{
“cnt”:1,
“p”:1,
“ps”:20,
“list”:[{
“goods_id”:“211”,
“goods_name”:“\u5927\u4fdd\u5065\u5305\u591c”,
“goods_price”:“1000.00”,
“main_image”:“www.xxxxxx.cn\/data\/upload\/shop\/adv\/04825861373036910.png”
}]
}
}
以php为示例,其中php中数组拼接格式为:
$array_data = array(
“code” =》 1,
“msg” =》 ‘’,
“ad” =》 array(
“cnt” =》 22,
“p” =》 2,
“ps” =》 20,
“list” =》 array(
0 =》 array(
“adv_title” =》 “这是广告标题1”,
“adv_link” =》 “m.xxxxxx.cn/advert/tbsync/”,
“open_target” =》 “2”,
“img_url” =》 “www.xxxxxx.cn\/data\/upload\/shop\/adv\/04825861373036910.png”
),
1 =》 array(
“adv_title” =》 “这是广告标题2”,
“adv_link” =》 “m.xxxxxx.cn\/advert\/newerDerate\/?430”,
“open_target” =》 “2”,
“img_url” =》 “www.xxxxxx.cn\/data\/upload\/shop\/adv\/04782825931526321.png”
)
)
),
“area” =》 array(
“cnt” =》 3,
“p” =》 1,
“ps” =》 20,
“list” =》 array(
0 =》 array(
“c_area_id” =》 “16”,
“c_area_name” =》 “深圳”,
“c_area_pic” =》 “04732773115385188.jpg”,
“english_name” =》 “shenzhen”,
“goodsCount” =》 “21”,
“img_url” =》 “www.xxxxxx.cn\/data\/upload\/shop\/adv\/04825861373036910.png”
),
1 =》 array(
“c_area_id” =》 “18”,
“c_area_name” =》 “湖南”,
“c_area_pic” =》 “04732773115385188.jpg”,
“english_name” =》 “hunan”,
“goodsCount” =》 “33”,
“img_url” =》 “www.xxxxxx.cn/data/upload/shop/adv/04825861373036910.png”
),
2 =》 array(
“c_area_id” =》 “2”,
“c_area_name” =》 “北京”,
“c_area_pic” =》 “04732773115385188.jpg”,
“english_name” =》 “beijing”,
“goodsCount” =》 “70”,
“img_url” =》 “www.xxxxxx.cn/data/upload/shop/adv/04825861373036910.png”
),
)
),
“goods_info” =》 array(
“cnt” =》 1,
“p” =》 1,
“ps” =》 20,
“list” =》 array(
0 =》 array(
“goods_id” =》 “211”,
“goods_name” =》 “大保健包夜”,
“goods_price” =》 “1000.00”,
“main_image” =》 “www.xxxxxx.cn/data/upload/shop/adv/04825861373036910.png”
)
)
)
);
接口尽量按一个页面一个接口,但是公用的一些接口信息,如地区分类信息等,做单独接口处理,但是结果参数规范,按照上面数据格式返回数据。
返回的xml数据格式,如下:
《?xml version=“1.0” encoding=“utf-8”?》
《data》
《code》1《/code》
《msg/》
《ad》
《cnt》22《/cnt》
《p》2《/p》
《ps》20《/ps》
《list》
《article》
《advtitle》这是广告标题1《/advtitle》
《advlink》m.xxxxxx.cn/advert/tbsync/《/advlink》
《opentarget》2《/opentarget》
《imgurl》www.xxxxxx.cn\/data\/upload\/shop\/adv\/04825861373036910.png《/imgurl》
《/article》
《article》
《advtitle》这是广告标题2《/advtitle》
《advlink》m.xxxxxx.cn\/advert\/newerDerate\/?430《/advlink》
《opentarget》2《/opentarget》
《imgurl》www.xxxxxx.cn\/data\/upload\/shop\/adv\/04782825931526321.png《/imgurl》
《/article》
《/list》
《/ad》
《area》
《cnt》3《/cnt》
《p》1《/p》
《ps》20《/ps》
《list》
《article》
《careaid》16《/careaid》
《careaname》深圳《/careaname》
《careapic》04732773115385188.jpg《/careapic》
《englishname》shenzhen《/englishname》
《goodsCount》21《/goodsCount》
《imgurl》www.xxxxxx.cn\/data\/upload\/shop\/adv\/04825861373036910.png《/imgurl》
《/article》
《article》
《careaid》18《/careaid》
《careaname》湖南《/careaname》
《careapic》04732773115385188.jpg《/careapic》
《englishname》hunan《/englishname》
《goodsCount》33《/goodsCount》
《imgurl》www.xxxxxx.cn/data/upload/shop/adv/04825861373036910.png《/imgurl》
《/article》
《article》
《careaid》2《/careaid》
《careaname》北京《/careaname》
《careapic》04732773115385188.jpg《/careapic》
《englishname》beijing《/englishname》
《goodsCount》70《/goodsCount》
《imgurl》www.xxxxxx.cn/data/upload/shop/adv/04825861373036910.png《/imgurl》
《/article》
《/list》
《/area》
《goodsinfo》
《cnt》1《/cnt》
《p》1《/p》
《ps》20《/ps》
《list》
《article》
《goodsid》211《/goodsid》
《goodsname》大保健包夜《/goodsname》
《goodsprice》1000.00《/goodsprice》
《mainimage》www.xxxxxx.cn/data/upload/shop/adv/04825861373036910.png《/mainimage》
《/article》
《/list》
《/goodsinfo》
《/data》
其中list中的数字下标用article代替,附php版本自定义的递归数组转xml函数:
function ArrtoXml($data, $rootNodeName = ‘data’, $xml=null)
{
// turn off compatibility mode as simple xml throws a wobbly if you don‘t.
if (ini_get(’zend.ze1_compatibility_mode‘) == 1)
{
ini_set (’zend.ze1_compatibility_mode‘, 0);
}
if ($xml == null)
{
$xml = simplexml_load_string(“《?xml version=’1.0‘ encoding=’utf-8‘?》《$rootNodeName /》”);
}
// loop through the data passed in.
foreach($data as $key =》 $value)
{
// no numeric keys in our xml please!
if (is_numeric($key))
{
// make string key.。.
$key = “article”。 (string) $key;
}
// replace anything not alpha numeric
$key = preg_replace(’/[^a-z]/i‘, ’‘, $key);
// if there is another array found recrusively call this function
if (is_array($value))
{
$node = $xml-》addChild($key);
// recrusive call.
ArrtoXml($value, $rootNodeName, $node);
}
else
{
// add single node.
$value = htmlentities($value);
$xml-》addChild($key,$value);
}
}
// pass back as string. or simple xml object if you want!
return $xml-》asXML();
}
注意事项:
当返回js时,即data_type=js,在json串前加入 RESULT=,即格式为RESULT={json串}。
当返回html时,即data_type=html,在返回的字符串中加入html头部,即DOCTYPE、HEAD、BODY等信息。
2.添加,修改,删除
当调用增删改数据接口时,code为1时表操作成功,当code大于1时,表示操作失败,并在msg中返回错误信息,如下:
{
“code”:101,
“msg”:“操作参数丢失!”
}
当然,若增删改后仍然需要返回响应数据,格式同查询。
评论