【问题标题】:How to map different UI views in a RESTful web application?如何在 RESTful Web 应用程序中映射不同的 UI 视图?
【发布时间】:2010-03-09 00:48:43
【问题描述】:

我正在设计一个 Web 应用程序,它将支持标准 UI(通过浏览器访问)和 RESTful API(基于 XML/JSON 的 Web 服务)。用户代理将能够通过在Accept HTTP 标头中使用不同的值来区分这些。

RESTful API 将使用以下 URI 结构(“文章”资源的示例):

  • GET /article/ - 获取文章列表
  • POST /article/ - 添加新文章
  • PUT /article/{id} - 更新基于{id} 的现有文章
  • DELETE /article/{id} - 删除基于{id} 的现有文章

应用程序的 UI 部分需要支持多个视图,例如:

  • 标准资源视图
  • 提交新资源的视图
  • 用于编辑现有资源的视图
  • 用于删除现有资源的视图(即显示删除确认)

请注意,后三个视图仍然通过GET 访问,即使它们是通过重载的POST 处理的。


可能的解决方案:
将附加参数(关键字)引入 URI 中,以识别单个视图 - 即在上述之上,应用程序将支持以下 URI(但仅适用于 Content-Type: text/html):

  • GET /article/add - 显示用于添加新文章的表单(通过GET 获取,通过POST 处理)
  • GET /article/123 - 在“查看”模式下显示文章 123(通过 GET 获取)
  • GET /article/123/edit - 在“编辑”模式下显示文章 123(通过GET 获取,通过PUT 处理,重载为POST)
  • GET /article/123/delete - 显示文章 123 的“删除”确认(通过GET 获取,通过DELETE 处理,重载为POST)

上述更好的实现可能是将 add/edit/delete 关键字放入 GET 参数中 - 因为它们不会更改我们正在使用的资源,所以最好让所有的基本 URI 保持相同其中。


我的问题是:
考虑到每个资源可以有多个视图,您如何将上述 URI 结构映射到提供给普通用户的 UI?您是否同意上面详述的可能解决方案,还是会根据您的经验推荐不同的方法?

注意:我们已经实现了一个应用程序,它由一个独立的 RESTful API 和一个独立的 Web 应用程序组成。我目前正在研究将这两者合并在一起的未来项目的选项(即为了减少开销)。

【问题讨论】:

    标签: web-services architecture rest user-interface


    【解决方案1】:

    在 REST 术语中 - “备用视图”实际上只是普通的旧资源,因为 URI 是不透明的。通过从一个到另一个的链接来发现关系 - 在这种情况下;从文章列表到文章,编辑和删除该文章。这里的关键是,你的 URI 结构实际上并不重要,即以下内容同样“正确”:

    GET /article/123/edit
    GET /article/123;edit
    

    答案真的只是品味问题。如果它们由 URI 标识,因此可以链接到,那么您就做对了。

    你会如何映射上面的 URI 为常规服务的 UI 的结构 用户,考虑到可以有 每个资源有几个视图?

    我会以与 HTML 应用程序完全相同的方式来执行此操作 - 即通过在 XML 中提供相同的超链接,以便连接/链接资源(视图),以便客户端在必要时跟随并在 UI 中呈现.

    例如

    GET /article/foobar
    
    200 OK
    Content-Type: application/mytype+xml
    ....
    <link rel="edit" href="/article/foobar;edit" />
    ....
    

    最后:

    您是否同意这种可能 上面详述的解决方案,或者你会 推荐基于不同的方法 根据你的经验?

    我认为您的上述方法是合理的 - 但是,您绝对应该关注链接关系而不是 URI 模式。

    您可以选择保持“更大粒度”的内容,并避免为您的 XML 驱动的应用程序单独删除(甚至编辑)资源;只需不在 XML 中链接到它们,而是选择在文章资源本身中包含删除/编辑链接和表单 - 这将与您对 HTML 驱动版本的初始提案一起工作。

    我一般来说,为 XML 和 HTML 驱动的应用程序使用相同资源的方法是一种很好的方法。

    【讨论】:

    • 嗨,迈克,连通性/链接关系绝对是我清单上的下一件事情(我想就我首先考虑的方法获得更多意见)。您有一个非常好的观点,即在 XML 中保持与资源的各个视图的链接——这是我没有考虑过的,但它非常有意义。非常感谢您提供如此全面的答案,非常感谢!
    【解决方案2】:

    我不确定我明白你为什么要将两者合并在一起;虽然这个想法似乎有道理,但我认为这实际上是一种虚假的经济。

    视图通常特定于其使用的上下文。您有两种不同类型的用户(人员和服务)都使用相同的通道 (HTTP),这一事实不应混淆。

    现在将它们分开可能看起来像是额外的工作,但是当 4 个月后发生某些事情时,这意味着您需要再次将它们分开,这将是更多的工作。关注点的分离超越了 UI/逻辑/数据。

    只要您的逻辑保持中心化并且具有凝聚力,那么在我的书中拥有两组视图就不是问题。

    作为一种折衷方案,您能否为两个视图保留相同的 URL 结构,但重复(即:一致)?

    【讨论】:

    • 嗨,Adrian,我想合并这两个部分以减少开销并设计一个通用/模块化系统。分离对于抽象很有效,但是两个部分都在相同的数据集上运行,并且本质上提供了相同的功能,因此在这种情况下,可能值得将它们合并。将来我可能真的需要将它们分开,但这最初将是一个旨在测试这个概念的实验平台。关于一致的方法:这会起作用,但它会使 URL 复杂化(在 API URI 中有方法)或给 UI 带来问题(HTML 不支持 PUT/DELETE)。
    猜你喜欢
    • 2020-06-26
    • 2014-09-15
    • 2018-01-17
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2016-02-06
    • 2014-01-09
    • 2021-11-05
    相关资源
    最近更新 更多