Restful接口指导规则完整解读.docVIP

Restful接口设计规范 Restful介绍 REST是“REpresentational State Transfer”缩写，能够翻译成“表现实状况态转换”，不过在绝大多数场所中我们只说REST或RESTful。为何会起这么一个奇怪名字呢？我们能够从上述这篇论文中找到答案。Fielding在论文中将REST定位为“分布式超媒体应用（Distributed Hypermedia System）”架构风格，它在文中提到一个名为“HATEOAS（Hypermedia as the engine of application state）”概念。 我们利用一个面向最终用户Web应用来对这个概念进行简单叙述：这里所谓应用状态（Application State）表示Web应用用户端状态，简单起见能够了解为会话状态。资源在浏览器中以超媒体形式展现，经过点击超媒体中链接能够获取其它相关资源或对目前资源进行对应处理，获取资源或针对资源处理响应一样以超媒体形式再次展现在浏览器上。由此可见，超媒体成为了驱动用户端会话状态转换引擎。 借助于超媒体这种特殊资源展现方法，应用状态转换表现为浏览器中展现资源转换。假如将超媒体深入抽象成通常意义上资源展现（Representation ）方法，那么应用状态变成了可被展现状态（REpresentational State）。应用状态之间转换就成了可被展现状态装换（REpresentational State Transfer），这就是REST。 运管平台/烽行平台Restful接口标准 接口命名规则 http://ip:端口/v2/接口名 IP：服务器IP地址 端口：Restful端口号 V2:版本号(2) 接口名： 命名规则：现有接口方法去第一个单词后，全小写命名，如： 用户余额信息实时查询能力，原接口名： queryBalanceRealSingle(String msisdn) Restful接口:http://ip:端口/v2/balancerealsingle 参数规则 参数提交方法：application/www-form-urlencoded 参数命名：单词采取小写，复合词采取下划线分开全小写命名。 参数规则：批量查询需有page_size和page_num参数，避免一次性查询，部分参数需有默认值设定。 附录：运管平台部分API规则 用户状态查询： 服务地址： http://ip:端口/v2/userstatusrealsingle 提供用户状态信息实时查询 请求参数说明: 参数 是否必需 默认值 格式举例 含义 appid 是 无 ‘100001’ 第三方应用唯一标示，由全网管理员在运行管理平台应用上线时分配 transid 是 无 ‘0001’ 事务ID，每次加1，用于判定是否是重放攻击 ebid 是 无 0001 能力id，运管平台生成 token 是 无 E4805d16520de693a3fe707cdc962045 加密 msisdn 是 无 1 所查询专网号码 output 否 json json或xml 请求返回格式 示例： http://ip:端口/v2/userstatus?appid=100001ebid=0001transid=1001 token=E4805d16520de693a3fe707cdc962045msisdn=1 返回值： { status : 0, message : ok, result : { status:’00’ } } 短信失败统计历史查询： 有LIST传输 待定 服务地址： http://ip:端口/v2/smsfaulthistory1 返回短信失败统计对应数据 请求参数说明: 参数 是否必需 默认值 格式举例 含义 appid 是 无 ‘100001’ 第三方应用唯一标示，由全网管理员在运行管理平台应用上线时分配 transid 是 无 ‘0001’ 事务ID，每次加1，用于判定是否是重放攻击 ebid 是 无 0001 能力id，运管平台生成 token 是 无 E4805d16520de693a3fe707cdc962045 加密 msisdn 是 无 1 所查询专网号码 output 否 json json或xml 请求返回格式 begin_time 是 无 1010 查询开始时间 查询时间范围：3个月内统计 end_time 是 无 1111 查询结束时间 查询时间范围：3个月内统计 page_size 否 10 10 返回统计数量，默认为10条统计，最大可设置为20条 page_num 否 0 0、1、2 分页页码，默认为0。 0代表第一页，1代表第二页，以这类推。 假如设置了此字段，则输出