wiki:2ndchild/interface

Version 5 (modified by hejingdong, 12 years ago) (diff)

--

一.基本约定

1.当接口处理正常时,HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。

2.当接口处理异常时,HTTP STATUS CODE 返回给500,并且给出具体的错误信息。
    {
	"uri" : "/intf/albums-by-type.jsp",
	"error-desc":"Need you follow uid.",
        "user-notice":"给用户的提示放在这里"
    }`
    
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的调用请求。

5.接口中的JSON字符串,key都用双引号("")包裹,value是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号。

二.业务相关接口列表

1.频道接口

URL:
提交方式:GET
参数:无
返回结果:JSON

2.资讯栏目接口

URL:
提交方式:GET
参数:无
返回结果:JSON

3.资讯文章列表接口

URL:
提交方式:GET
参数:
  channelId-栏目id
返回结果:JSON

4.资讯文章终端接口

URL:
提交方式:GET
参数:
  articleId-文章id
返回结果:HTML页面

5.资讯文章评论接口

URL:
提交方式:GET
参数:
返回结果:JSON

6.二胎政策接口

URL:
提交方式:GET
参数:
返回结果:JSON

7.最新关注接口

URL:
提交方式:GET
参数:
返回结果:HTML页面

8.(热门话题)帖子接口

URL:
提交方式:GET
参数:
返回结果:HTML页面

9.办事单位地点添加接口

URL:
提交方式:POST
参数:
返回结果:JSON

10.单独二胎政策实施时间添加接口

URL:
提交方式:POST
参数:
返回结果:JSON

11.办事指南接口

URL:
提交方式:GET
参数:
返回结果:JSON

12.办事指南纠错接口

URL:
提交方式:POST
参数:
返回结果:JSON

13.办事指南详细解释接口

URL:
提交方式:GET
参数:
返回结果:HTML页面

14.精彩活动接口

URL:
提交方式:GET
参数:
返回结果:HTML页面

15.百科列表接口

URL:
提交方式:GET
参数:
返回结果:JSON

16.百科终端接口

URL:
提交方式:GET
参数:
返回结果:HTML页面

二.业务无关接口列表

1.更新token接口

URL:
提交方式:POST
参数:
返回结果:JSON

2.登录接口

URL:
提交方式:POST
参数:
返回结果:JSON