Changes between Version 1 and Version 2 of web-intf

Timestamp:

12/06/2011 05:40:38 PM (14 years ago)

Author:

yangbo

Comment:

--

web-intf

@@ -1 @@
- == 摄影部落IPAD版接口列表 ==
+== 摄影部落IPAD版接口 ==
+
+=== 基本约定 ===
+{{{
+1.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。
+2.当接口处理异常时，HTTP STATUS CODE 返回给500，并且给出具体的错误信息。
+3.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。在JSP的最顶部，实现类似下面的代码：
+
+        String queryString = request.getQueryString();
+        String requestEncoding = getParam(queryString,"req_enc");
+        String responseEncoding = getParam(queryString,"resp_enc");
+        if(isNotBlank(requestEncoding)){
+            request.setCharacterEncoding(requestEncoding);
+        }
+        if(isNotBlank(responseEncoding)){
+            response.setCharacterEncoding(responseEncoding);
+        }
+}}}
+
+
+4.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。
+
 
 === 1. /intf/albums-by-type.jsp  获取分类相册 ===
@@ -13 +34 @@
     返回参数： 
     {"albums":[{"uid":2323,
-                "small-img-src":"{{{http://img.pconline.com.cn/123.jpg}}}",
+                "small-img-src":"http://img.pconline.com.cn/123.jpg",
                 "album-id":1233,
                 "theme":"拍摄主题",
@@ -33 +54 @@
     clicks：点击数
 
-    排序方式：图集更新时间逆序
+    排序方式：图集创建时间逆序
 }}}
 
@@ -63 +84 @@
     page-no：
     page-size：
-    kw：搜索关键字
+    kw：搜索关键字(采用UTF-8方式编码)
     uid：用户id
     small-img-src：封面图片URL
@@ -73 +94 @@
     clicks：点击数
 
-
-    排序方式：XXXX
+    排序方式：图集创建时间逆序
 }}}
 
@@ -114 +134 @@
     }
 
-    page-no：
-    page-size：
-    total：
+    page-no：请求的页码，第一次为1。
+    page-size：每个页面的记录数。
+    total：这次查询的记录总数。
     uid：用户id
     logo：用户头像
@@ -138 +158 @@
     camera：相机
 
-    排序方式：
-    XXXX
+    排序方式：按图集保存的顺序，和WEB上的图片显示顺序保持一致
 }}}
 
@@ -149 +168 @@
               page-no：单个作者的图集分页页码
               page-size：单个作者的图集分页数量
+              req-enc：请求时字符编码，缺省是UTF-8  
+              resp-enc：响应时字符编码，缺省是UTF-8 
     返回参数：
     {"users":[{"page-size":5,
@@ -182 +203 @@
     picked：精华作品（0：非精华，1：精华）
 
-    错误列表：
-    1.提交的关注用户过多，请分批提交。
+    排序方式：1、不同的用户，uids中，uid的先后顺序来进行排列。
+              2、同一个用户下的图集，先出精华的（按图集发表时间逆序），后出普调图集（按图集发表时间逆序）.
+
 }}}
 
@@ -190 +212 @@
 {{{
     HTTP请求方式：post
-    是否需要登录：否
+    是否需要登录：否，这里会有匿名评论的情况。
     提交参数：album-id：图集id
               req-enc：请求时字符编码，缺省是UTF-8
@@ -225 +247 @@
                  ]
     }
-    page-no
-    page-size
-    total
-    album-id
-    comment-id
-    comment
-    timer    
+    page-no：请求的页码，第一次为1。
+    page-size：每个页面的记录数。
+    total：这次查询的记录总数。
+    album-id：图集id
+    comment-id：评论id
+    comment：评论正文
+    timer：评论时间（格式是 yy-mm-dd hi:mm）
     排序方式：按timer倒序
 }}}
@@ -241 +263 @@
     提交参数：album-id：图集id
               device-id：设备ID
-    其他规则：一个设备，一天内，只能对单个作品，投票一次
+              req-enc：请求时字符编码，缺省是UTF-8  
+              resp-enc：响应时字符编码，缺省是UTF-8 
+    其他规则：一个设备，一天内(到当天晚上的23:59:59)，只能对单个作品，投票一次
     返回参数：
     {"album-id":2323,"vote":2323}