【发布时间】:2013-02-27 22:02:04
【问题描述】:
每个 Web 应用程序 - 每个网站 - 都是一项服务。 (...) 使网站易于网络冲浪者使用的功能也使网络服务 API 易于程序员使用。
Richardson 和 Ruby,“RESTFul Web 服务”
如我所愿,一个同时也是 Web 服务的网站根据用户代理请求的内容提供其资源的多种表示。 API 可以说是网站本身,并不单独提供。
许多流行的“REST API”并非如此。例如,Twitter 的 API 位于 http://api.twitter.com/1/,URI 中的“1”是 API 本身的版本。 Socialcast 还在 https://demo.socialcast.com/api/ 提供了一个 REST API,第三级名称是它所寻址的网络的名称。
这对我来说似乎是错误的。如果我的博客位于http://www.example.com/blog,我不需要在不同的位置提供 API,只为机器人提供 JSON。我不应该拥有 http://www.example.com/blog/posts/ 和 http://api.example.com/blog/posts 这两个不同的 URI,而应该只拥有前者和多种可用的表示形式,其中 application/json 用于我希望提供给我的用户的 JSON API。
示例 1:浏览器询问我博客上的帖子;
请求:
curl -i \
-H "Accept: text/html" \
-X GET \
http://www.example.org/blog/posts/
回应:
200 OK
Content-Type: text/html; charset=utf-8
<html><body><h1>Posts</h1><ol><li><h2>My first post ...
示例 2:相同的 URI,但这次是机器人发出请求;
请求:
curl -i \
-H "Accept: application/json" \
-X GET \
http://www.example.org/blog/posts/
回应:
200 OK
Content-Type: text/html; charset=utf-8
{
"posts": [
{
"id": 1,
"title": "My first post" ...
API 的版本号应编码在请求标头的“Accept”字段中,最重要的是避免像 Twitter 那样强烈键入 URI(“statuses/show.json?id=210462857140252672”或“statuses/show/ 210462857140252672.json”)。
如果采用统一方法,我可能会失去一些灵活性(但不应该 Cool URIs never change?),但我认为坚持 REST(或至少我对它的解释)会带来更多好处。
哪种方法更正确:分离 API 和网站,还是统一它们?
【问题讨论】:
标签: http rest web url-design