如何设计restful风格接口

restful风格接口
URL定位资源,用HTTP动词(GET,POST,DELETE,DETC)描述操作。
识别(identify)、 表示(represent) 、交互(interact with)。
  • 看Url就知道要什么
  • 看http method就知道干什么
  • 看http status  code就知道结果如何

1. REST描述的是在网络中client和server的一种交互形式;REST本身不实用,实用的是如何设计 RESTful API(REST风格的网络接口);

2. Server提供的RESTful API中,URL中只使用名词来指定资源,原则上不使用动词。“资源”是REST架构或者说整个网络处理的核心。比如:
http://api.qc.com/v1/newsfeed: 获取某人的新鲜;
http://api.qc.com/v1/friends: 获取某人的好友列表;
http://api.qc.com/v1/profile: 获取某人的详细信息;

3. 用HTTP协议里的动词来实现资源的添加,修改,删除等操作。即通过HTTP动词来实现资源的状态扭转:
GET 用来获取资源,
POST 用来新建资源(也可以用于更新资源),
PUT 用来更新资源,
DELETE 用来删除资源。比如:
DELETE http://api.qc.com/v1/friends: 删除某人的好友 (在http parameter指定好友id)
POST http://api.qc.com/v1/friends: 添加好友
UPDATE http://api.qc.com/v1/profile: 更新个人资料

4. Server和Client之间传递某资源的一个表现形式,比如用JSON,XML传输文本,或者用JPG,WebP传输图片等。当然还可以压缩HTTP传输时的数据(on-wire data compression)。

5. 用 HTTP Status Code传递Server的状态信息。比如最常用的 200 表示成功,500 表示Server内部错误等。
如何设计restful风格接口
1、REST 是面向资源的,这个概念非常重要,而资源是通过 URI 进行暴露。
比如:左边是错误的设计,而右边是正确的
GET /rest/api/getDogs –> GET /rest/api/dogs 获取所有小狗狗
GET /rest/api/addDogs –> POST /rest/api/dogs 添加一个小狗狗
GET /rest/api/editDogs/:dog_id –> PUT /rest/api/dogs/:dog_id 修改一个小狗狗
GET /rest/api/deleteDogs/:dog_id –> DELETE/rest/api/dogs/:dog_id 删除一个小狗狗

2、REST很好地利用了HTTP本身就有的一些特征,如HTTP动词、HTTP状态码、HTTP报头等等。
  • HTTP动词
GET 获取一个资源
POST 添加一个资源
PUT 修改一个资源
DELETE 删除一个资源
  • HTTP状态码
200 OK
400 Bad Request
500 Internal Server Error
  • HTTP报头
Authorization 认证报头
Cache-Control 缓存报头
Cnotent-Type 消息体类型报头
……

怎么用RESTful

1、每个资源使用2个URL,网址中只能有名词
2、对于资源的操作类型由HTTP动词来表示
3、统一的返回结果
4、返回正确的状态码
5、允许通过HTTP内容协商,建议格式预定义为JSON
6、对可选发杂的参数,使用查询字符串(?)
7、返回有用的错误信息(message)
8、非资源请求用动词,这看起似乎和1中的说法有矛盾,但这里指的是非资源,而不是资源

本站所有文章均来自互联网,如有侵权,请联系站长删除。极客文库 » 如何设计restful风格接口
分享到:
赞(0)

评论抢沙发

评论前必须登录!