REST 规则表述(第一部分)。

[b]URI格式[/b]
第一:正斜杠(/)必须用来表示层级关系。

第二:正斜杠(/)不能出现在URI的结尾处。
例如:
错误的表示方式是:
http://xxxx.yyyy.com/shapes/
正确的表示方式是:
http://xxxx.yyyy.com/shapes

第三:连字符(-)是用来改善URI的可读性的
例如:http://xxxx.yyyy.com/this-is-my-first-post

第四:不要在URI中使用下划线(_)

第五:URI中应当全部使用小写字母(不包括查询参数)

第六:不要在URI中描述文件的格式
例如:
错误的表示方式是:
http://xxxx.yyyy.com/data/user.json
正确的表示方式是:
http://xxxx.yyyy.com/data/user


[b]URI资源原型 Resource Archetypes[/b]

Document
文档资源是一个独特的概念,类似于一个对象实体,或数据库记录。以下的每个URI都标记了一个文档资源:
http://api.soccer.restapi.org/leagues/seattle
http://api.soccer.restapi.org/leagues/seattle/teams/trebuchet
http://api.soccer.restapi.org/leagues/seattle/teams/trebuchet/players/mike


Store
存储是一个客户端管理的资源库。客户可以放入、取出、删除它们,例如:
PUT /users/1234/favorites/alonso

Collection
集合资源是服务器端管理的目录,客户可能会提出一个新的资源被放入到集合中。以下的每个URI都标记了一个资源集合:
http://api.soccer.restapi.org/leagues
http://api.soccer.restapi.org/leagues/seattle/teams
http://api.soccer.restapi.org/leagues/seattle/teams/trebuchet/players


Controller
资源模型的控制器是一个程序概念。Controller就像执行某种方法函数。例如常见的CRUD操作。以下URI描述了请求后台Controller的写法:

GET /read/245743/remark -->读取245743的描述信息
GET /read/245743/body -->读取245743的主要文字


[b]URI 路径设计[/b]

第一:文档名称必须使用单数名词

第二:集合必须是复数名词

第三:Store的名字必须是复数名词。

第四:Controller的名称必须是一个动词或动词短语

第五:可变路径的值,应该使用基于身份认证的值(例如ID)

第六:CRUD 函数名不能出现在URI中
例如:
错误的表示方法:
GET /deleteUser?id=1234
GET /deleteUser/1234
DELETE /deleteUser/1234
POST /users/1234/delete
以上都是错误的表示方法,而正确的表示方法如下:
DELETE /users/1234

[b]URI的查询设计[/b]

第一:一个URL应当可以过滤集合(或存储(store))
例如:
GET /users -->查询所有用户
GET /users?role=admin -->根据条件过滤用户

第二:分页查询应当单独列出来
例如:
GET /users?pageSize=25&pageStartIndex=50
POST /users/search
  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值