json key 命名规范_restful接口命名规范.doc

restful接口命名规范

篇一：Restful接口规则(完整)

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接口标准 1.接口命名规则

IP：服务器IP地址

端口：Restful端口号 V2:版本号(2) 接口名：

命名规则：现有接口方法去第一个单词后，全小写命名，如：

用户余额信息实时查询能力，原接口名：

queryBalanceRealSingle(String msisdn) Restful接口:

2.参数规则

参数提交方式：application/www-form-urlencoded 参数命名：单词采取小写，复合词采取下划线分开的全小

写命名。

参数规则：批量查询需有page_size以及page_num参数，避免一次性查询，部分参数需有默认值设定。

附录：运管平台部分API规则 用户状态查询：

status : 0, message : ok, result : {

status:’00’ } }

短信失败记录历史查询： 有LIST传递 待定

&begintimeamp;endtime返回值：

{

status : 0, message : ok, result :[ {

} ] }

用户实时位置信息查询

status : 0,

篇二：业务侧接口-RESTfulAPI OneNet接入方案与RESTfulAPI接口

目录

OneNet接入方案与RESTfulAPI接口 1

1 概述 3

2 基于OneNet的应用系统的典型场景 3

3 API资源模型 3

4 REST API 5

4.1

4.2

4.3 设计原则 5 HTTP 原始报文格式 6 设备(device) 6

4.3.1 新增 6

4.3.2 更新 7

4.3.3 查看 8

4.3.4 删除 11

4.4 数据流(datastream) 12

4.4.1 新增 12

4.4.2 更新 12

4.4.3 查看 13

4.4.4 删除 14

4.5 数据点(datapoint) 14

4.5.1 新增 14

4.5.2 更新 17

4.5.3 查看 17

4.5.4 删除 20

4.6 触发器(trigger) 20

4.6.1 新增 20

4.6.2 更新 22

4.6.3 查看 22

4.6.4 删除 24

4.7 API 权限(apikey) 24

4.7.1 新增 24

4.7.2 更新 25

4.7.3 查看 25

4.7.4 删除 26

4.8 二进制数据(bindata) 27

4.8.1

新增 27

4.8.2 查看 27

4.8.3 删除 28

4.9 命令执行(cmd) 28

4.9.1 发送命令 28

4.9.2 查看状态 29

4.9.3 获取响应 29

4.10 其他 30

4.10.1 触发数据内容 30

4.10.2

历史数据