Changes between Initial Version and Version 1 of web-intf


Ignore:
Timestamp:
02/03/2012 11:14:14 AM (14 years ago)
Author:
yangbo
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • web-intf

    v1 v1  
     1== 汽车网车友汇项目接口 == 
     2 
     3=== 目录 === 
     4 1. [#point100 基本约定 ] 
     5 
     6 2. [#point200 互动核心平台接口 ] 
     7 
     8 2.1 [#point201 发送系统消息 ] 
     9 
     10 2.2 [#point202 获取系统消息 ] 
     11 
     12 2.3 [#point203 更新系统消息状态 ] 
     13 
     14 3. [#point300 PASSPORT接口 ] 
     15 
     16 3.1 [#point301 登录接口 ] 
     17 
     18 3.2 [#point302 自动激活接口 ] 
     19 
     20 3.3 [#point303 辨认登录状态接口 ] 
     21 
     22 
     23 4. [#point400 BBS接口 ] 
     24 
     25 4.1 [#point401 BBS发帖接口 ] 
     26 
     27 5. [#point500 车友会接口 ] 
     28 
     29 5.1 [#point501 创建活动 ] 
     30 
     31 5.2 [#point502 获取活动（行程、成员） ] 
     32 
     33 5.3 [#point503 创建行程 ] 
     34 
     35 5.4 [#point504 修改行程 ] 
     36 
     37 5.5 [#point505 活动报名 ] 
     38 
     39 5.6 [#point506 删除活动成员 ] 
     40 
     41 5.7 [#point507 发表活动总结（记账） ] 
     42 
     43 5.8 [#point508 修改活动总结（记账） ] 
     44 
     45 5.9 [#point509 上传活动图片 ] 
     46 
     47 5.10 [#point510 创建用户 ] 
     48 
     49 5.11 [#point511 修改用户资料 ] 
     50 
     51 5.12 [#point512 获取用户资料 ] 
     52 
     53 5.13 [#point513 车友会查询 ] 
     54 
     55 5.14 [#point514 维护我关注的车友会 ] 
     56 
     57 5.15 [#point515 获取地区列表 ] 
     58 
     59 5.16 [#point516 获取评论列表 ] 
     60 
     61 5.17 [#point517 发表评论 ] 
     62 
     63 5.18 [#point518 获取推荐活动列表 ] 
     64 
     65 5.19 [#point519 查询路书 ] 
     66 
     67 5.20 [#point520 热门推荐 ] 
     68 
     69 5.21 [#point521 同车友会推荐 ] 
     70 
     71 5.22 [#point522 同地区推荐 ] 
     72 
     73=== 1. [=#point100 基本约定] === 
     74{{{ 
     751.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 
     76 
     772.当接口处理异常时，HTTP STATUS CODE 返回给500，并且给出具体的错误信息。 
     78    { 
     79        "uri" : "/intf/albums-by-type.jsp", 
     80        "error-code":"20502", 
     81        "error-desc":"Need you follow uid.", 
     82        "user-notice":"给用户的提示放在这里" 
     83    } 
     84 
     85     
     863.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。在JSP的最顶部，实现类似下面的代码： 
     87 
     88        String queryString = request.getQueryString(); 
     89        String requestEncoding = getParam(queryString,"req_enc"); 
     90        String responseEncoding = getParam(queryString,"resp_enc"); 
     91        if(isNotBlank(requestEncoding)){ 
     92            request.setCharacterEncoding(requestEncoding); 
     93        } 
     94        if(isNotBlank(responseEncoding)){ 
     95            response.setCharacterEncoding(responseEncoding); 
     96        } 
     97 
     984.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。 
     99 
     1005.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号。 
     101 
     102}}} 
     103 
     104== 2. [=#point200 互动核心平台接口 ]  == 
     105=== 2.1 [=#point201 发送系统消息 ] === 
     106 
     107=== 2.2 [=#point202 获取系统消息 ] === 
     108 
     109=== 2.3 [=#point203 更新系统消息状态 ] === 
     110 
     111== 3. [=#point300 PASSPORT接口 ]  == 
     112=== 3.1 [=#point301 登录接口 ] === 
     113=== 3.2 [=#point302 自动激活接口 ] === 
     114=== 3.3 [=#point303 辨认登录状态接口 ] === 
     115 
     116 
     117== 4. [=#point400 BBS接口 ]  == 
     118=== 4.1 [=#point401 BBS发帖接口 ] === 
     119 
     120 
     121== 5. [=#point500 车友会接口 ] == 
     122=== 5.1 [=#point501 创建活动 ] === 
     123=== 5.2 [=#point502 获取活动（行程、成员） ] === 
     124=== 5.3 [=#point503 创建行程 ] === 
     125=== 5.4 [=#point504 修改行程 ] === 
     126=== 5.5 [=#point505 活动报名 ] === 
     127=== 5.6 [=#point506 删除活动成员 ] === 
     128=== 5.7 [=#point507 发表活动总结（记账） ] === 
     129=== 5.8 [=#point508 修改活动总结（记账） ] === 
     130=== 5.9 [=#point509 上传活动图片 ] === 
     131=== 5.10 [=#point510 创建用户 ] === 
     132=== 5.11 [=#point511 修改用户资料 ] === 
     133=== 5.12 [=#point512 获取用户资料 ] === 
     134=== 5.13 [=#point513 车友会查询 ] === 
     135=== 5.14 [=#point514 维护我关注的车友会 ] === 
     136=== 5.15 [=#point515 获取地区列表 ] === 
     137=== 5.16 [=#point516 获取评论列表 ] === 
     138=== 5.17 [=#point517 发表评论 ] === 
     139=== 5.18 [=#point518 获取推荐活动列表 ] === 
     140=== 5.19 [=#point519 查询路书 ] === 
     141=== 5.20 [=#point520 热门推荐 ] === 
     142=== 5.21 [=#point521 同车友会推荐 ] === 
     143=== 5.22 [=#point522 同地区推荐 ] ===