REST服务接口文档

1、深圳市CMS系统REST月艮接口文档项目代号：CMS-2014-09-15深圳市定制化服务工作室2014-10-02深圳市绿协管理系统需求规格说明书V1.01、 引言31.1、 REST 介绍31.2、 编写目的 31.3、 编写原则 31.4、 变更历史42、 我的链接服务列表 错误！未定义书签。2.1、 添加标签分类 42.2、 删除分类标签 42.3、 更新分类标签 42.4、 获取分类标签列表 42.5、 添加我的链接连接 42.6、 更新我的链接连接 42.7、 删除我的链接连接42.8、 查询我的链接连接 4第2页共8页深圳市轩蓝创新科技工作室深圳市绿协管理系统需求规格说明书V1.

2、01、 引言1.1、 REST 介绍REpresentational State Transfer (REST) 是一种架构原则，其中将 web服务视为资源， 可以由其 URL唯一标识。RESTful Web服务的关键特点是明确使用HTTP方法来表示不同的操作的调用。REST的基本设计原则对典型CRUD操作使用 HTTP协议方法：POST -创建资源GET -检索资源PUT -更新资源DELETE -删除资源REST服务的主要优势在于：它们是跨平台(Java、.net、PHP等)高度可重用的，因为它们都依赖基本 HTTP协议。 它们使用基本的 XML ,而不是复杂的 SOAP XML ,使用非

3、常方便。基于REST的web服务日益成为后端企业服务集成的首选方法。与基于 SOAP的 web服务相比，它的编程模型简单，而本机 XML (而不是 SOAP )的使用减少了序 列化和反序列化过程的复杂性，并且不再需要其他作用相同的第三方库。1.2、 编写目的编写本文的目的是为了将系统功能进行模块化、服务化，将用户的操作以服务的方式提供。系统与系统之间遵循服务规范，将系统与系统之间的交互转为定制化服务交互，以实现系统与系统之间的集成。1.3、 编写原则可寻址性(Addressability ) REST中的所有东西都基于资源的概念。资源与 OOP中的对象或其 他名词不同，它是一种抽象，必须可以通

4、过 URI寻址或访问。接口一致性(Interface uniformity )与SOAP或其他标准不同，REST要求用来操纵资源的方法 或动词不是任意的。这意味着 RESTful服务的开发人员只能使用 HTTP支持的方法，比如 GET、 PUT、POST、DELETE等等。因此不需要使用 WSDL等服务描述语言。无状态(Statelessness )为了增强可伸缩性，服务器端不存储客户机的状态信息。这使服务器不与 特定的客户机相绑定，负载平衡变得简单多了。这还让服务器更容易监视、更可靠。第3页共8页深圳市轩蓝创新科技工作室深圳市绿协管理系统需求规格说明书V1.0具象(Representatio

5、nal )客户机总是与资源的某种具象交互，绝不会直接与资源本身交互。同一资 源还可以有多个具象。理论上说，持有资源的具象的任何客户机应该有操纵底层资源的足够信息。连通性(Connectedness )任何基于REST的系统都应该预见到客户机需要访问相关的资源，应该在返回的资源具象中包含这些资源。例如，可以以超链接的形式包含特定RESTful服务的操作序列中的相关步骤，让客户机可以根据需要访问它们。1.4、 变更历史序号变更人员变更时间变更内容1邵震2014-10-02我的链接服务 2.1、2.2、2.3、2.4、2.5、2.6、2.7、2.82、公共连接服务列表2.1、 添加公共连接分类请求方

6、式PUT服务路径/commonlink/add/commonlinktype路径参数/描述无参数类型application/json参数描述 name":"分类 1"备注：name：分类名称返回值类型application/json描述添加成功：result:。添加失败：result:1, “id ": “ 123456'id:分类id不允许重复添加：result:2第4页共8页深圳市轩蓝创新科技工作室深圳市绿协管理系统需求规格说明书V1.02.2、 删除公共连接分类请求方式DELETE服务路径/commonlink/delete/type/id

7、路径参数/描述id:分类id参数类型无参数描述无返回值类型application/json描述添加成功：result:。 添加失败：result:12.3、 更新共连接分类请求方式UPDATE服务路径/commonlink/update/type/id路径参数/描述id:分类id参数类型application/json参数描述 name":"分类 1"备注：name：分类名称返回值类型application/json描述添加成功：result:。 添加失败：result:12.4、 获取共连接分类列表请求方式GET服务路径/commonlink/list/type

8、s路径参数/描述无第5页共8页深圳市轩蓝创新科技工作室参数类型无参数描述无返回值类型application/json描述 lfst”: id":“123456”,"name":“xxx 官网”，力力A力userid : 1 ,“ordrid":"1",用id:标签分类name：标签分类名称orderid:标签分类排序id深圳市绿协管理系统需求规格说明书V1.02.5、 添加公共连接请求方式PUT服务路径/commonlink/add/url路径参数/描述无参数类型application/json参数描述 name : xxx , ur

9、l : , typename: type1 ,1 newwin : 1 name公共连接名称url:公共连接urltypename：公共连接分类名称newwin：是否在新窗口中打开，0表小否，1表小是返回值类型application/json描述添加成功：result:。添加失败：result:1不允许往同一尖型下添加重复连接：result:2第6页共8页深圳市轩蓝创新科技工作室深圳市绿协管理系统需求规格说明书V1.02.6、 更新公共连接请求方式UPDATE服务路径/commonlink/update/url路径参数/描述无参数类型application/json参数描述 name : xx

10、x , url : , tagname: tag1 1name我的链接连接名称url ：我的链接连接urltagname：标签分类名称返回值类型application/json描述添加成功：result:。 添加失败：result:12.7、 删除公共连接请求方式DELETE服务路径/commonlink/delete/url/id路径参数/描述id:公共连接id参数类型application/json参数描述 id":“连接 id” id:连接id返回值类型application/json描述删除成功：result:。删除失败：result:12.8、 查询公共连接列表请求方式GET第7页共8页深圳市轩蓝创新科技工作室服务路径/commonlink/find/urls/tagid路径参数/描述tagid:标签分类id参数类型无参数描述无返回值类型application/json描述 Commonlinklist ”: id":“1