rest服务接口文档

《rest服务接口文档》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

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

2、接4深圳市轩蓝创新科技工作室第8页共8页深圳市绿协管理系统需求规格说明书V1.01、引言1.1、REST介绍REpresentationalStateTransfer(REST)是一种架构原则，其中将web服务视为资源，可以由其URL唯一标识。RESTfulWeb服务的关键特点是明确使用HTTP方法来表示不同的操作的调用。REST的基本设计原则对典型CRUD操作使用HTTP协议方法：POST-创建资源GET-检索资源PUT–更新资源DELETE-删除资源REST服务的主要优势在于：它们是跨平台(Java、.net、PHP等）高度可重用的，因为它们都依赖基本HTTP协议。它们使用基本

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

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

5、resentational）客户机总是与资源的某种具象交互，绝不会直接与资源本身交互。同一资源还可以有多个具象。理论上说，持有资源的具象的任何客户机应该有操纵底层资源的足够信息。连通性（Connectedness）任何基于REST的系统都应该预见到客户机需要访问相关的资源，应该在返回的资源具象中包含这些资源。例如，可以以超链接的形式包含特定RESTful服务的操作序列中的相关步骤，让客户机可以根据需要访问它们。基于REST的Web服务日益成为后端企业服务集成的1.1、变更历史序号变更人员变更时间变更内容1邵震2014-10-02我的链接服务2.1、2.2、2.3、2.4、2.5、2

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

7、link/delete/type/{id}路径参数/描述id：分类id参数类型无参数描述无返回值类型application/json描述添加成功：{result:0}添加失败：{result:1}1.2、更新共连接分类请求方式UPDATE服务路径/commonlink/update/type/{id}路径参数/描述id：分类id参数类型application/json参数描述{“name”:”分类1”}备注：name：分类名称返回值类型application/json