你的位置:首页 > ASP.net教程

[ASP.net教程]Rest服务介绍及定义标准


1、            引言................................................................................................................... 3

1.1、        REST介绍.................................................................................................. 3

       1.1、        编写目的……………………………………………………………………………3

1.2、        编写原则..................................................................................................... 3

1.3、        变更历史..................................................................................................... 3

2、            我的收藏服务列表.............................................................................................. 4

2.1、        添加标签分类.............................................................................................. 4

2.2、        删除分类标签.............................................................................................. 4

2.3、        更新分类标签.............................................................................................. 4

2.4、        获取分类标签列表....................................................................................... 4

2.5、        添加我的收藏连接....................................................................................... 4

2.6             更新我的收藏连接....................................................................................... 4

2.7             删除我的收藏连接....................................................................................... 4

2.8             查询我的收藏连接....................................................................................... 4

1、            引言

1.1、   REST介绍

REpresentational State Transfer (REST) 是一种架构原则,其中将 web 服务视为资源,可以由其 URL 唯一标识。RESTful Web 服务的关键特点是明确使用 HTTP 方法来表示不同的操作的调用。

REST 的基本设计原则对典型 CRUD 操作使用 HTTP 协议方法:

POST - 创建资源

GET - 检索资源

PUT – 更新资源

DELETE - 删除资源

REST 服务的主要优势在于:

它们是跨平台 (Java、.net、PHP 等)高度可重用的,因为它们都依赖基本 HTTP 协议。

它们使用基本的

 

基于 REST 的 web 服务日益成为后端企业服务集成的首选方法。与基于 SOAP 的 web 服务相比,它的编程模型简单,而本机

 

1.2、   编写目的

编写本文的目的是为了将系统功能进行模块化、服务化,将用户的操作以服务的方式提供。系统与系统之间遵循服务规范,将系统与系统之间的交互转为定制化服务交互,以实现系统与系统之间的集成。

1.3、   编写原则

可寻址性(AddressabilityREST 中的所有东西都基于资源 的概念。资源与 OOP 中的对象或其他名词不同,它是一种抽象,必须可以通过 URI 寻址或访问。

接口一致性(Interface uniformity与 SOAP 或其他标准不同,REST 要求用来操纵资源的方法或动词不是任意的。这意味着 RESTful 服务的开发人员只能使用 HTTP 支持的方法,比如 GET、PUT、POST、DELETE 等等。因此不需要使用 WSDL 等服务描述语言。

无状态(Statelessness为了增强可伸缩性,服务器端不存储客户机的状态信息。这使服务器不与特定的客户机相绑定,负载平衡变得简单多了。这还让服务器更容易监视、更可靠。

具象(Representational客户机总是与资源的某种具象交互,绝不会直接与资源本身交互。同一资源还可以有多个具象。理论上说,持有资源的具象的任何客户机应该有操纵底层资源的足够信息。

连通性(Connectedness任何基于 REST 的系统都应该预见到客户机需要访问相关的资源,应该在返回的资源具象中包含这些资源。例如,可以以超链接的形式包含特定 RESTful 服务的操作序列中的相关步骤,让客户机可以根据需要访问它们。基于 REST 的 Web 服务日益成为后端企业服务集成的

1.4、   变更历史

序号

变更人员

变更时间

变更内容

1

66 Internet

 2014-10-02

我的收藏服务2.1、2.2、2.3、2.4、2.5、2.6、2.7、2.8

 

 

 

 

 

 

 

 


 

2、      我的收藏服务列表

2.1、 添加标签分类

 

请求方式

PUT

服务路径

/bookmark/add/bookmarktag

路径参数/描述

参数类型

application/json

参数描述

{“name”:”标签1”}

备注:ame:标签名称

返回值类型

application/json

描述

添加成功:{result:0}

添加失败:{result:1}

不允许重复添加: {result:2}

 

2.2、 删除分类标签

 

请求方式

DELETE

服务路径

/bookmark/delete/tag/{id}

路径参数/描述

id:分类标签id

参数类型

参数描述

返回值类型

application/json

描述

添加成功:{result:0}

添加失败:{result:1}

 

2.3、 更新分类标签

请求方式

UPDATE

服务路径

/bookmark/update/tag/{id}

路径参数/描述

id:分类标签id

参数类型

application/json

参数描述

{“name”:”标签1”}

备注:ame:标签名称

返回值类型

application/json

描述

添加成功:{result:0}

添加失败:{result:1}

 

2.4、 获取分类标签列表

请求方式

GET

服务路径

/bookmark/list/tags

路径参数/描述

参数类型

参数描述

返回值类型

application/json

描述

{“list”:[{“id”:”123456”,

”name”:”华为官网”,

”userid”:”1”,

“orderid”:”1”,

“count”:20},…,}]

id:标签分类

name:标签分类名称

orderid:标签分类排序id

count:此分类标下下的收藏连接总数

 

2.5、 添加我的收藏连接

请求方式

PUT

服务路径

/bookmark/add/url

路径参数/描述

参数类型

application/json

参数描述

{“name”:”huawei”,”url”:”http://www.huawei.com”,”tagname”:”tag1”}

name:我的收藏连接名称

url:我的收藏连接url

tagname:标签分类名称

返回值类型

application/json

描述

添加成功:{result:0}

添加失败:{result:1}

不允许往同一标签下添加重复连接: {result:2}

 

2.6、 更新我的收藏连接

请求方式

UPDATE

服务路径

/bookmark/update/url

路径参数/描述

参数类型

application/json

参数描述

{“name”:”huawei”,”url”:”http://www.huawei.com”,”tagname”:”tag1”}

name:我的收藏连接名称

url:我的收藏连接url

tagname:标签分类名称

返回值类型

application/json

描述

添加成功:{result:0}

添加失败:{result:1}

 

2.7、 删除我的收藏连接

请求方式

DELETE

服务路径

/bookmark/delete/url/{tagid}

路径参数/描述

tagid:标签分类id

参数类型

application/json

参数描述

{“id”:”连接id”}

id: 连接id

返回值类型

application/json

描述

删除成功:{result:0}

删除失败:{result:1}

 

2.8、 查询我的收藏连接

请求方式

GET

服务路径

/bookmark/find/bookmarks/{tagid}

路径参数/描述

tagid:标签分类id

参数类型

参数描述

返回值类型

application/json

描述

{“bookmarklist”:[{“id”:”123456”,

”name”:”华为官网”,

“url”:”1”,

”userid”:”1”,

 

},…,}], “count”:20}

id:连接id

name:连接名称

url:连接url

userid:用户id

count:收藏连接总数

 《《相关资料下载