【问题标题】:Should the WebDAV PROPFIND method be used with JSON in REST APIs?WebDAV PROPFIND 方法是否应该与 REST API 中的 JSON 一起使用?
【发布时间】:2016-04-28 10:08:35
【问题描述】:

我正在构建一个到处使用 JSON 的 Web 服务。

现在我需要一个 HTTP 方法来检索资源的属性(例如,只读、写入、ACL 等属性)。看起来只有一种 HTTP 方法可用于此目的:PROPFIND。

但是the spec 明确指示使用 XML。

无论如何将那个动词与 JSON 接口一起使用是不是很疯狂? 我还担心PROPFIND 是 WebDAV 扩展的一部分。

如果不可行,在面向 JSON 的 Web 服务中检索资源属性的推荐动词或推荐方法是什么?

【问题讨论】:

    标签: json web-services rest


    【解决方案1】:

    在“代表性状态转移”架构中,想法是:

    • 使用非常有限的一组输入/输出动词,其形式属性可以被普遍定义(例如,GET 和 HEAD 是 安全,PUT 和 DELETE 是 幂等),
    • 用无限数量的资源来规避这少量的动词。

    因此,使用 HTTP 中定义的动词以外的动词是个坏主意。事实上,每个 WebDAV 动词都可以用 HTTP 动词(以及相应的标头和资源)完成。

    在 RESTful 世界中,您有多种选择:

    • 为元数据定义一种新的资源,
    • 在同一资源的表示中混合数据和元数据,
    • 将元数据作为 HTTP 标头进行管理(请注意,如果您需要获取不含数据的元数据,可以使用 HEAD 动词)。

    【讨论】:

    • 感谢您的回答。我可能会选择 HTTP 标头选项,因为我根本无法创建一种新的资源。通常我不太喜欢使用标头,它们使 API 复杂化并且更容易出错(用户更难记住、CORS 问题、代理错误等)。 +1 ;)
    【解决方案2】:

    REST 独立于协议,但它经常通过 HTTP 协议实现。 WebDAV 是 HTTP 协议的扩展。所以,理论上你可以使用WebDAV methods(这并不意味着你应该)。

    来自菲尔丁论文的chapter 6:

    6.3.1.2 Extensible Protocol Elements

    [...] HTTP 请求语义由请求方法名称表示。只要可以在客户端、服务器和可能位于它们之间的任何中介之间共享一组标准化的语义,就允许方法扩展。 [...]

    保持简单并坚持使用标准 HTTP 方法:它们是众所周知的,并且受到大量客户端和代理的支持。

    请参阅下面的几种方法,您可以使用 HTTP 动词从资源中获取元数据:

    使用子资源

    您可以拥有一个metadata 子资源,用于您想要请求一些元数据的资源。例如,要获取用户资源的元数据,就这么简单:

    GET /api/users/johndoe/metadata HTTP/1.1
    Host: example.com
    Accept: application/json
    

    使用自定义媒体类型

    您可以考虑的另一种方法是自定义媒体类型,例如 application/vnd.company.metadata+json,用于表示资源的元数据。因此,您将有以下内容:

    GET /api/users/johndoe HTTP/1.1
    Host: example.com
    Accept: application/vnd.company.metadata+json
    

    通过这种方法,同一端点可以支持其他媒体类型,例如 application/json 和/或 application/vnd.company+json 以返回数据本身:

    GET /api/users/johndoe HTTP/1.1
    Host: example.com
    Accept: application/json
    
    GET /api/users/johndoe HTTP/1.1
    Host: example.com
    Accept: application/vnd.company+json
    

    如果您需要,可以使用另一种媒体类型(例如 application/vnd.company.full+json)来请求资源的数据和元数据:

    GET /api/users/johndoe HTTP/1.1
    Host: example.com
    Accept: application/vnd.company.full+json`
    

    GitHub API 使用了类似的方法。

    【讨论】:

    • 谢谢,这很有趣。然而,在我的情况下这是不可能的,因为它在我的网络服务中已经有了一些意义:几乎所有资源都有孩子,而且由于所有资源都可以使用 ID 和 slug 来定位,我无法区分 metadata 和一个名为“元数据”的常规用户创建的 slug。无论如何,+1 ;)
    • 再次感谢,这种新方法也很有趣。但是,我想我会为我当前的项目使用标题方式。但我会在下一个项目中明确地记住 MIME 类型的方法。 ;)
    【解决方案3】:

    当您尝试创建 HTTP Web 服务时,肯定还有一些可以在 HTTP 标头中使用的方法。 但也有许多属性属性,其中包含有关请求/响应的信息 像 “状态”、“内容类型”等

    您也可以在您的网络服务中设置这些属性。 喜欢

    “内容类型”:“应用程序/json”;

    在这里,当您在任何“请求/响应”中设置此属性时,这意味着您在“请求/响应”中只允许特定的 MIME 类型数据。

    我对 HTTP 请求/响应有基本的了解,希望这些信息对您有所帮助/p>

    否则你可以点击这个链接www.webdev.org

    【讨论】:

    • 感谢您的回答,这也是 Cássio Mazzochi Molin 的建议。这次,我将使用自定义标头方法。 +1 ;)
    猜你喜欢
    • 1970-01-01
    • 2021-11-26
    • 1970-01-01
    • 1970-01-01
    • 2016-02-10
    • 1970-01-01
    • 2015-03-23
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多