【问题标题】:Should a Web site also be a Web resource?一个网站也应该是一个网络资源吗?
【发布时间】: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


    【解决方案1】:

    Web 和 RESTful API 的行为方式可能不同。

    理论上,像http://mysite.com/blog/1 这样的请求如何区分它需要返回 HTML 页面还是只返回数据(JSON、XML...)?我会投票支持使用Accept http 标头:

    Accept: text/html <-- Web browsers
    Accept: application/json <-- Applications/Relying parties consuming data or performing actions
    

    为什么 Twitter、Facebook 或其他网站不混合使用 Web 浏览器和依赖方?老实说,我认为这是一个武断的决定。

    也许我可以提供一个可能的原因:Web 浏览器/搜索引擎机器人 URL 应该是 friendly-URLs,因为它们在 SEO 上效果更好。出于这个原因,也许 SEO 就绪的 URL 在 REST 方面不是很语义化,但它们适用于搜索引擎甚至人类用户!

    最后:哪个更好(这是我的看法)?

    • 您需要 SEO,然后使用单独的网址。
    • 你不需要SEO,然后统一同域同格式的URL。

    【讨论】:

      【解决方案2】:

      我不同意另一个答案,即这个决定应该与 SEO 或 URL 的“友好”程度有关(机器人也是 [由] 人编写的!)。但我的直觉告诉我,更好的 SEO 结果将来自 统一 URI,因为这也统一了您的 API URI 从万维网链接到的(不太可能的)事件中的 pagerank。

      这个决定应该取决于你的服务器和客户端的能力。如果他们可以设置 Accept 请求标头,并且您的服务器足够聪明,可以进行透明的内容协商,那么一定要统一 URI。这就是我所做的(我唯一的 JSON 客户端是我自己,发出从我的 Web 应用程序的其他 HTML 部分提供的 AJAX 请求,我在其中控制 Accept 标头)。

      如果客户端无法设置请求标头,例如 Web 用户想要获取 json 响应,则它们最终会使用默认值(可能是 text/html)。出于这个原因,您可能希望允许在唯一 URI(/foo.txt、/foo.rtf)下发生非协商响应。通常这是通过将格式附加到由点分隔的 URI 来完成的,就好像它是文件扩展名一样(但通常不是,mod_rewrite 会做杂耍),以便需要文件扩展名的平台上的旧客户端可以保存文件一个有意义的。

      我网站上的大多数页面都是这样工作的:

      1. 根据请求 URL 确定 SQL 查询。 (例如/cars?colour=black => SELECT * FROM cars WHERE colour='black')
      2. 发出 SQL 查询。
      3. 从此文件支持的列表中确定可接受的响应类型。这通常是 HTML 和 HAL(即 JSON),但有时也是 XML。如果没有其他可以接受的,请回退到 text/html。
      4. if(HTML) 吐出&lt;HEAD&gt; 和&lt;NAV&gt;(考虑参数:&lt;h1&gt;Black Cars&lt;/h1&gt;)
      5. 使用最可接受的响应类型输出结果。
        此函数知道如何获取 SQL 结果对象并将其转换为 HTTP Link 标头、HTML &lt;LINK&gt; 元素流、HAL 的 _links 键、XLink 元素流、HTML &lt;TABLE&gt; 元素(带有单元格包含 &lt;A&gt; 元素)或 CSV 文件。 SQL 查询可能返回 0 行,在这种情况下,如果正在使用该输出,则会写入用户友好的消息而不是 HTML 表。
      6. 如果(HTML)吐出&lt;FOOTER&gt;

      这个基本大纲在我的网络应用程序中处理了大约 30 个不同的资源集合,尽管每个集合都有一组不同的请求 URI 可能调用的选项,因此每个开始在参数验证方面都不同。

      所以,现在我已经解释了所有这些,您可以看到将每个资源的所有细节集中在一个地方处理,以及由通用库函数处理以格式 X 或格式 Y 输出的泛型是多么有用.这是一个实现细节,它让我的生活变得轻松,并帮助我坚持不要重复自己的格言。

      【讨论】:

      • 在理想的世界里,你是对的。在现实世界中,您需要http://mysite.com/blog/my-blog-post-title/1/2012-02-14。这就是为什么我提到 SEO 是 URL 架构中的一个重要点。
      • 不,你让我从头到尾。我是说你也应该为你的 API 使用http://mysite.com/blog/my-blog-post-title/1/2012-02-14。 SEO 影响 URL 的选择,很好,但不影响是否将相同的 URL 用于可协商的资源。
      • 嗯,但对我来说,使用 API 的友好 URL 似乎很难看。事实上,friendly-URL 可能会因为市场需求而改变。使用它们对于 REST 来说不够稳定。另一方面,SEO 打破了良好 SEO API 的规则:它在资源导向方面无话可说:它只是在线营销!
      • 如果资源移动,任何有竞争力的网站管理员都会设置重定向,这些重定向将适用于使用旧 URL 的网络冲浪者和 API 客户端。从 REST 的角度来看,API 选择没有“规则”,只有遵循 HATEOAS 约束。
      • 我的意思是 SEO 友好的 URL 从 REST 的角度来看并不好。但这是你的意见,我尊重它。
      【解决方案3】:

      这里没有对错。当您的 API 开发是由特定的客户端需求驱动时,过于紧密地遵循 REST 和 RFC 可能会变得很困难。

      实际上,与 API 客户端相比,人类用户具有不同的行为模式,因此需要不同的处理方式。最生动的区别在于,许多 API 都是数据密集型的,专为批量操作和数据转储而设计,而面向人类用户的应用程序更“反应性”,并且经常一步一步、一个请求一个请求地做事。因此,在许多项目中,API 的 URL 设计已优化,以避免在多次网络往返和重复存储调用上浪费客户端和服务器资源。

      在底层,API 实现通常具有与核心应用不同的设计,并针对 API 提供的操作类型进行了优化。例如,API 实现可能使用单独的缓存策略。现在,如果您将代码拆分出来,您可能希望创建一个只处理 API 调用的主机集群。这就是将 API 放在另一个域上对 负载管理 有益的地方:一个单独的域允许在高负载站点上进行更简单的负载平衡。相比之下,当您在同一个域名(但有单独的集群)上使用 /api URL 前缀时,您需要一个智能(L7 感知)负载均衡器来完成在 API 和 Web 前端集群之间拆分请求流的工作,但这样的负载均衡器更昂贵。

      因此,Twitter 之类的公司将 API 分离出来可能有很好的技术原因,但对其他实现的引用可能不适用于您的项目。如果您处于设计的早期阶段,您可能希望从同一域上的统一 URL 方案开始,但最终您可能会发现有很好的现实用例使您改变方法,然后...重构。

      附:这里有一个关于版本控制的冗长讨论 - Best practices for API versioning?

      附言我发现强类型 URL 有助于快速调试。您可以简单地使用 .json 将 URL 放入浏览器并快速获得结果,而无需切换到命令行。但同意你的观点,“接受”标题是首选方法

      P.S.S.S. API 的 SEO?我可以看到一个好的 URL 设计是如何有益的,但对于搜索引擎来说,如果您的服务在同一路径/域名上提供多种输出格式,它可能无关紧要。归根结底,搜索引擎是为人类用户构建的,人类用户不会使用 XML 和 JSON。

      【讨论】:

        【解决方案4】:

        我绝对不同意网站 == 网络服务的做法。

        简单地说,网站应该被视为一个客户端,只是一个客户端,它使用 Web 服务并以适当的形式呈现数据以供 Web 使用。就像移动应用程序是一个客户端,只是一个客户端,使用相同的网络服务并以适当的形式呈现数据以供移动使用。

        网络服务是服务提供者。所有其他人都只是客户;网站、android 应用、iphone 应用等。

        【讨论】:

          猜你喜欢
          • 2018-02-19
          • 2020-02-18
          • 1970-01-01
          • 1970-01-01
          • 2019-08-17
          • 1970-01-01
          • 1970-01-01
          • 2021-06-03
          • 1970-01-01
          相关资源
          最近更新 更多