Changes between Version 5 and Version 6 of pconline_4.3.0/interface

Timestamp:

10/13/2015 09:23:27 AM (11 years ago)

Author:

wuchangbo

Comment:

--

pconline_4.3.0/interface

@@ -6 +6 @@
 
 ----------
-== 1.基本约定 ==
-{{{
-接口通用参数
-req_enc=utf-8(必须放url后面)
-resp_enc=utf-8(必须放url后面)
-common_session_id=xxxx(以cookies中的优先)
-
-接口URL: 接口URL
-必填参数：参数名=xxx(多种情况用括号解析)
-非必填参数：参数名=xxx(多种情况用括号解析)
-说明文档参数：添加某特定参数可以直接看接口文档
-是否需要登录：是,否
-返回格式：json,ssi,xml
-缓存方式：接口缓存，对象缓存
-缓存时间：缓存时间
-返回结果：结果可能情况
-}}}
-
-== 2.接口列表 ==
-=== 2.1首页头条 ===
-{{{
-备注：cms需提供条件或者字段让mrobot判断文章的类型，并要增加主播名字段
-1）mrobot接口url：http://mrobot.pconline.com.cn/v2/cms/channels/1?pageSize=20&pageNo=1
-2）后端接口：[[BR]]
+
+== 1.接口列表 ==
+----------
+=== 1.1首页头条 ===
+mrobot接口：http://mrobot.pconline.com.cn/v2/cms/channels/1?pageSize=20&pageNo=1 [[BR]]
+后端接口：[[BR]]
 ios：http://www.pconline.com.cn/app/21json/
 安卓：http://www.pconline.com.cn/android/21json/
-HTTP请求方式：get
-是否需要登录：否
-返回格式：JSON
-是否有缓存：有
-返回参数：
+**说明**
+
+> cms需提供条件或者字段让mrobot判断文章的类型，并要增加主播名字段 [[BR]]
+
+**缓存时间**
+
+>无
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=||
+||pageNo||页码||string|| || ||页码||
+||pageSize||每页条数||string|| || ||每页条数||
+**返回**
+{{{#!java
 {
     "articleList": [
@@ -70 +74 @@
 }
 }}}
-
-
-=== 2.2栏目定制===
-{{{
-备注：栏目定制增加图片URL
-1）mrobot接口url：
-iOS：http://mrobot.pconline.com.cn/configs/pconline_v7_cms_iphone_channel_tree
-Android：http://mrobot.pconline.com.cn/configs/pconline_v7_cms_android_channel_tree
-HTTP请求方式：get
-是否需要登录：否
-返回格式：JSON
-是否有缓存：有
-返回参数：
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||
+
+----------
+
+=== 1.2栏目定制===
+mrobot接口：[[BR]]
+iOS：http://mrobot.pconline.com.cn/configs/pconline_v7_cms_iphone_channel_tree[[BR]]
+Android：http://mrobot.pconline.com.cn/configs/pconline_v7_cms_android_channel_tree[[BR]]
+**说明**
+
+> 栏目定制增加图片URL [[BR]]
+
+**缓存时间**
+
+>无
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+> 无
+
+**返回**
+{{{#!java
 {
     "news": [
@@ -109 +135 @@
 }
 }}}
-
-
-=== 2.3论坛广场===
-{{{
-备注：论坛广场每日热帖列表、论坛帖子列表页增加三张缩略图，没有分页一次返回
-1）mrobot接口url：http://itbbs.pconline.com.cn/mobile/topics.ajax
-HTTP请求方式：get
-是否需要登录：否
-返回格式：JSON
-是否有缓存：有
-返回参数：
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||
+
+
+
+
+=== 1.3论坛广场===
+mrobot接口：http://itbbs.pconline.com.cn/mobile/topics.ajax [[BR]]
+**说明**
+
+> 论坛广场每日热帖列表、论坛帖子列表页增加三张缩略图，没有分页一次返回 [[BR]]
+
+**缓存时间**
+
+>无
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+> 无
+
+**返回**
+{{{#!java
 {
     "desc": "成功",
@@ -151 +200 @@
 }
 }}}
-
-
-=== 2.4视频广告===
-{{{
-备注：广告系统新增视频音频标识（isMedia=1表示带视频或音频的广告，isMedia=0表示普通广告)
-1）mrobot接口url：http://mrobot.pconline.com.cn/s/onlineinfo/ad/ad.xsp
-2）后端接口：[[BR]]
-  http://ivy.pconline.com.cn/adpuba/show?id=pc.khd.zx.zx4.&media=js
-HTTP请求方式：get
-是否需要登录：否
-返回格式：JSON
-是否有缓存：有
-返回参数：
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||
+
+
+
+
+
+=== 1.4视频广告===
+mrobot接口：http://mrobot.pconline.com.cn/s/onlineinfo/ad/ad.xsp [[BR]]
+后端接口：[[BR]]
+http://ivy.pconline.com.cn/adpuba/show?id=pc.khd.zx.zx4.&media=js[[BR]]
+**说明**
+
+> 广告系统新增视频音频标识（isMedia=1表示带视频或音频的广告，isMedia=0表示普通广告) [[BR]]
+
+**缓存时间**
+
+>无
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+> 无
+
+**返回**
+{{{#!java
 {
     "twlb1": [
@@ -196 +269 @@
 }
 }}}
-
-
-=== 2.5启动页===
-{{{
-备注：Android因为不需要适配不同分辨率的机型，因此默认读取image字段，IOS那边则需要判断返回的JSON数据是否有’ios’这个属性有则读取对应的倍图没有则读取image字段过期时间CMS后台设置，当启动图过期时image字段返回为空即可
-1）mrobot接口url：http://mrobot.pconline.com.cn/pconline/skin
-HTTP请求方式：get
-是否需要登录：否
-返回格式：JSON
-是否有缓存：有
-返回参数：
-{
-                 //默认启动图
-                 "image":"http://www.sinaimg.cn/qc/photo_auto/photo/50/11/1485011/1485011_src.jpg",
-   
-        //IOS的启动图 
-                "ios":{
-                                  // 针对I4以下机型
-                 "i4":"http://www.sinaimg.cn/qc/photo_auto/photo/50/11/1485011/1485011_src.jpg",
-                //针对I5机型 
-                                 "i5":"http://www.sinaimg.cn/qc/photo_auto/photo/50/11/1485011/1485011_src.jpg",
-                //针对I6机型 
-                                 "i6":"http://www.sinaimg.cn/qc/photo_auto/photo/50/11/1485011/1485011_src.jpg",
-                                 //针对I6+机型
-                                 "i6p":"http://www.sinaimg.cn/qc/photo_auto/photo/50/11/1485011/1485011_src.jpg"
-         }
-}
-}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||
+
+
+
+
+=== 1.5启动页===
+mrobot接口：http://mrobot.pconline.com.cn/pconline/skin [[BR]]
+**说明**
+
+> Android因为不需要适配不同分辨率的机型，因此默认读取image字段，IOS那边则需要判断返回的JSON数据是否有’ios’这个属性有则读取对应的倍图没有则读取image字段过期时间CMS后台设置，当启动图过期时image字段返回为空即可 [[BR]]
+
+**缓存时间**
+
+>无
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+> 无
+
+**返回**
+{{{#!java
+{
+      //默认启动图
+      "image":"http://www.sinaimg.cn/qc/photo_auto/photo/50/11/1485011/1485011_src.jpg",
+      //IOS的启动图 
+      "ios":{
+            // 针对I4以下机型
+            "i4":"http://www.sinaimg.cn/qc/photo_auto/photo/50/11/1485011/1485011_src.jpg",
+            //针对I5机型 
+            "i5":"http://www.sinaimg.cn/qc/photo_auto/photo/50/11/1485011/1485011_src.jpg",
+            //针对I6机型 
+            "i6":"http://www.sinaimg.cn/qc/photo_auto/photo/50/11/1485011/1485011_src.jpg",
+            //针对I6+机型
+            "i6p":"http://www.sinaimg.cn/qc/photo_auto/photo/50/11/1485011/1485011_src.jpg"
+       }
+}
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||
+
+