rest - 模拟HTTP上的过程调用的最佳/最RESTful方法是什么？-6ren

rest - 模拟HTTP上的过程调用的最佳/最RESTful方法是什么？

转载作者：行者123 更新时间：2023-12-01 06:07:03

我有一个服务，需要一个.odt模板文件和一些文本值，并在输出时生成一个.odt。我需要通过HTTP使此服务可用，但我不太了解使接口正常工作的最RESTful方法是什么。

我需要能够将模板文件和输入值提供给服务器-并将生成的.odt文件发送回给我。我看到的工作方式如下：

将模板放置或发布到服务器，然后执行GET请求，并传递我刚发布的模板的URI，再加上输入值-GET响应主体将带有.odt
在单个GET请求中发送模板和参数-模板文件将放在GET请求主体中。
像上面的（2）一样，除了将整个事情作为单个POST请求而不是GET进行。

（1）的问题是我不想将模板文件存储在服务器上。这增加了复杂性，并且存储文件对我而言无济于事，因为它是一种非常RESTful的方法。同样，在其他所有条件相同的情况下，单个请求要比2好。

（2）的问题在于，将主体放入GET请求与滥用HTTP接壤-我正在使用的软件支持它，但可能并非总是如此。

数字（3）似乎具有误导性，因为这更自然地是“读取”或“获取”操作而不是“发布”操作。

我正在做的事情本质上就像一个函数调用-我需要传递大量数据，而实际上我只是在使用HTTP作为在网络上公开我的代码的便捷方式。也许我想做的是天生就没有REST风格，并且没有REST友好的解决方案？有人可以建议吗？谢谢！

最佳答案

哇，所以这个答案很快就升级了...

在过去的一年左右的时间里，我试图通过书籍，邮件列表等对REST进行更好的理解。出于某种原因，我决定选择您的问题作为对我所学知识的检验。

抱歉：P

让我们将整个示例简化一个步骤。不必担心用户上传文件，而是假设用户只是传递了一个字符串。因此，实际上，除了要替换的字符参数（键/值列表）之外，它们还将传递字符串。稍后我们将处理文件上传部分。

这是一种RESTful方式，不需要在服务器上存储任何内容。我将使用一些HTML（尽管损坏，但我将省略诸如HEAD之类的东西）作为我的媒体类型，只是因为它是众所周知的。

样品溶液

首先，用户将需要访问我们的REST服务。

GET /

<body>
    <a rel="http://example.com/rels/arguments" href="/arguments">
        Start Building Arguments
    </a>
</body>

基本上，这为用户提供了一种开始与我们的服务进行实际交互的方式。现在，它们只有一个选项：使用链接构建一组新的参数（将在字符串替换方案中最终使用的名称/值对）。因此，用户转到该链接。

GET /参数

<body>
    <a rel="self" href="/arguments"/>
    <form rel="http://example.com/rels/arguments" method="get" action="/arguments?{key}={value}">
        <input id="key" name="key" type="text"/>
        <input id="value" name="value" type="text"/>
    </form>
    <form rel="http://example.com/rels/processed_string" action="/processed_string/{input_string}">
        <input id="input_string" name="input_string" />
    </form>
</body>

这将我们带到“参数”资源的实例。注意，这不是一个JSON或XML文档，它仅向您返回键/值对的纯数据；这是超媒体。它包含将用户引导到下一步操作的控件（有时称为允许用户“跟随他们的鼻子”）。此特定的URL（“ /参数”）代表键/值配对的空列表。如果可以的话，我很可能将URL命名为“ / empty_arguments”：这是一个为什么以URL来考虑REST却很愚蠢的例子：URL到底是什么并不重要。

在此新的HTML中，为用户提供了三种不同的资源，他们可以导航到这些资源：

他们可以使用指向“自己”的链接来导航到当前使用的相同资源。
他们可以使用第一种形式导航到一个新资源，该资源代表一个参数列表，并带有在表单中指定的其他名称/值对。
他们可以使用第二种形式提供希望最终替换的字符串。

注意：您可能已经注意到，第二种形式具有一个奇怪的“操作” URL：

/arguments?{key}={value}

在这里，我作弊：我正在使用 URI Templates。这使我可以指定如何将参数放置在URL上，而不是使用仅使用 <input-name>=<input-value>的默认HTML方案。显然，要使其正常工作，用户不能使用浏览器（因为浏览器未实现此功能）：他们将需要使用能够理解HTML和URI模板的软件。当然，我以HTML为例，您的REST服务可以使用某种支持URI模板规范所定义的URI模板化的XML。

无论如何，假设用户要添加其参数。用户使用第一种形式（例如，用“作者”填写“键”输入，用“约翰·多伊”填写“值”）。这导致...

GET / arguments？Author = John％20Doe

<body>
    <a rel="self" href="/arguments?Author=John%20Doe"/>
    <form rel="http://example.com/rels/arguments" method="get" action="/arguments?Author=John%20Doe&{key}={value}">
        <input id="key" name="key" type="text"/>
        <input id="value" name="value" type="text"/>
    </form>
    <form rel="http://example.com/rels/processed_string" action="/processed_string/{input_string}?Author=John%20Doe">
        <input id="input_string" name="input_string" />
    </form>
</body>

现在，这是一种全新的资源。您可以将其描述为带有单个键/值对的参数列表（键/值对）：“作者” /“约翰·多伊”。 HTML与以前几乎相同，但有一些更改：

现在，“自我”链接指向当前资源URL（从“ / arguments”更改为“ / arguments？Author = John％20Doe”
现在，第一种形式的“ action”属性具有更长的URL，但是我们再次使用URI模板来构建更大的URI。
第二种形式

用户现在想要添加“日期”参数，因此他们再次提交了第一个表单，这次的键为“日期”，值为“ 2003-01-02”。

GET / arguments？Author = John％20Doe＆Date = 2003-01-02

<body>
    <a rel="self" href="/arguments?Author=John%20Doe&Date=2003-01-02"/>
    <form rel="http://example.com/rels/arguments" method="get" action="/arguments?Author=John%20Doe&Date=2003-01-02&{key}={value}">
        <input id="key" name="key" type="text"/>
        <input id="value" name="value" type="text"/>
    </form>
    <form rel="http://example.com/rels/processed_string" action="/processed_string/{input_string}?Author=John%20Doe">
        <input id="input_string" name="input_string" />
    </form>
</body>

最终，用户准备处理他们的字符串，因此他们使用第二种形式并填写“ input_string”变量。这再次使用URI模板，从而将用户带到下一个资源。假设该字符串如下：

{Author} wrote some books in {Date}

结果将是：

GET / processed_string /％7BAuthor％7D + wrote + some + books + in +％7BDate％7D？Author = John％20Doe＆Date = 2003-01-02

<body>
    <a rel="self" href="/processed_string/%7BAuthor%7D+wrote+some+books+in+%7BDate%7D?Author=John%20Doe&Date=2003-01-02">
    <span class="results">John Doe wrote some books in 2003-01-02</span>
</body>

EW！要做很多工作！但这是（AFAIC）RESTful，并且满足了不需要在服务器端实际存储任何内容的要求（包括参数列表或最终要处理的字符串）。

重要注意事项

在此重要的一件事是，我不仅在谈论URL。实际上，大多数时候，我在谈论HTML。 HTML是超媒体，它是REST中被遗忘的重要部分。所有那些说“非常紧张”的API都说“使用这些参数在此URL上执行GET，并使用看起来像这样的文档在此URL上进行POST”，这些都没有在实践REST。罗伊·菲尔丁（Roy Fielding）（字面上是 wrote the book on REST） made this observation himself。

要注意的另一件事是，仅设置参数会很麻烦。在初始GET /之后，进入服务的根目录（您可以将其视为“菜单”），您将需要再执行五个GET调用，以建立您的参数资源以使参数资源为四个键/值配对。不使用HTML可以缓解这种情况。例如，我已经在示例中使用了URI模板，没有理由说HTML不足以支持REST。使用支持类似于表单但具有指定值“映射”功能的超媒体格式（例如XML的某种派生），您可以一次完成此操作。例如，我们可以扩展HTML媒体类型以允许另一种称为“映射”的输入类型...

只要使用我们的API的客户端了解什么是“映射”输入类型，他们就可以使用单个GET构建其参数资源。

那时，您甚至可能不需要“参数”资源。您可以直接跳到包含映射和实际字符串的“ processed_string”资源...

文件上传呢？

好的，所以最初您提到文件上传，以及如何在不需要存储文件的情况下进行上传。好吧，基本上，我们可以使用现有示例，但是将最后一步替换为文件。

在这里，除了上传文件外，我们基本上与以前做相同的事情。重要的是要注意的是，现在我们在提示用户（通过表单上的“ method”属性），他们应该执行POST而不是GET。请注意，即使到处都听到POST是不安全的（它可能导致服务器上的更改），非幂等操作，但并没有说必须在服务器上更改状态。

最后，服务器可以返回新文件（甚至更好的方法是返回一些超媒体或LOCATION标头，并带有指向新文件的链接，但这需要存储）。

最后评论

这只是这个特定示例的一小部分。我希望您已获得某种见识，但我告诫您将其视为福音。我确定有些事情我说的并不是真正的“ REST”。我计划发布此问题并回答 REST-Discuss Mailing List，看看其他人对此有何评论。

我希望借此表达的一件事是，最简单的解决方案可能就是使用RPC。毕竟，您最初使它成为RESTful尝试的尝试是什么？如果您想告诉别人您完成了“ REST”，请记住，很多API都声称自己是“ RESTful”，而这些API实际上只是被带有名词而非动词的URL伪装成RPC。

如果是因为您已经听说过REST的一些好处，以及如何通过使您的API RESTful隐式地获得这些好处，那么不幸的事实是REST的意义不仅仅在于URL，无论是GET还是POST到URL。超媒体扮演着重要的角色。

最后，有时您会遇到问题，这意味着您可能会执行SEEM非RESTful的操作。也许您需要执行POST而不是GET，因为URI（理论上有无限的存储空间，但有很多技术限制）会变得太长。那么，您需要执行POST。也许

更多资源：

REST-Discuss

My e-mail on this answer to REST-Discuss

RESTful Web Services Cookbook
Hypermedia APIs with HTML5 and Node（不是专门针对REST的，而是有关Hypermedia的非常好的介绍）

关于rest - 模拟HTTP上的过程调用的最佳/最RESTful方法是什么？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/9727394/

文章推荐： xslt - 在 XSLT 转换期间在输出文档的特定点插入元素

rest - 非 RESTful 与 RESTful
我对编程真的很陌生，并且在理解 RESTful API 的概念时遇到了一些麻烦。我读过 REST 和 RESTful API。我已经查看了 SO 中已经提出的问题，但似乎无法更好地理解该主题。在我的
rest - 简单来说，REST，RESTFul，SOA和微服务是什么？
我以为我知道REST /“RESTFul”，restfulservices，webservices，SOA和微服务是什么，但是我遇到了许多不同的定义，我得出的结论是这些术语被过度使用，滥用或完全错误定
rest - SharePoint REST 在单个 REST 查询中获取用户标题
我有一个列表，其中有一个“人员和组”列。当我使用 REST 查询行时，我会在此列中列出用户 ID。我发现这篇文章将帮助我将每个 id 转换为标题 http://www.codeproject.com
rest - 什么是 REST 调用以及如何发送 REST 调用？
我想问一些关于 REST 调用的问题。我是 REST 调用的绿色，我想了解什么是 REST 调用以及如何使用 URL 向服务器发送 REST 调用。谁能给我一些基本的教程或链接供我引用？另外，如果我
rest - 为什么 REST Web 服务称为 REST
很难说出这里问的是什么。这个问题模棱两可、含糊不清、不完整、过于宽泛或言辞激烈，无法以目前的形式合理回答。如需帮助澄清此问题以便可以重新打开，visit the help center . 8年前关闭
rest - 什么是监视 REST 资源以进行更改的 RESTful 方式？
如果有一个 REST 资源我想监视来自其他客户端的更改或修改，那么最好(也是最 RESTful)的方法是什么？我这样做的一个想法是通过提供特定资源来保持连接打开，而不是在资源不(尚)存在时立即返回。
rest - RESTful 服务中的分页
我有一个可以返回大量项目的 RESTful API，我希望能够使用分页样式技术来限制项目数量，这是 RESTful API 中的一个好主意吗？如果有可能最好通过链接(在这种情况下为 url)或请求正
rest - RESTful 发布多个实体的策略
我仍然处于适应以 REST 方式做事的过程中。在我的情况下，客户端软件将与 RESTful 服务交互。很少，客户端会上传其整个实体数据库(每个实体序列化为大约 5kb 的 xml 块)。也许我错了
rest - REST 中的子资源和路径变量冲突？
设计一个路径解析可能有歧义的 REST API 是否被认为是不好的做法？例如: GET /animals/{id} // Returns the animal with the given ID
rest - REST 是如何无状态的？
我知道 REST 并且知道在不使用 session 的情况下创建 RESTful Web 服务，我更了解它，但我不太了解无状态的概念以及使用 REST 如何使您的应用程序可扩展有人可以解释 REST
rest - REST API的单点登录支持
我正在尝试找到解决以下问题的最佳方法:我们的应用程序是SaaS，它支持Web登录的SAML。该应用程序还公开了应该在自动化和无人值守的流程中使用的REST API，这意味着没有交互式用户可以键入凭据。
rest - REST 是否可以建立连接池？
由于 REST 是无状态的，因此传入的每个请求都不知道传入的前一个请求。在这种情况下是否可以使用连接池？如果要实现连接池，它将像标准数据库连接一样在每个请求时打开连接池并关闭它。如何实现 REST
rest - 得墨忒耳定律与 REST
得墨忒耳定律(真的应该是得墨忒耳的建议)说你不应该“穿过”一个物体去接触它们的子物体。如果您作为客户需要执行一些重要的操作，大多数情况下您使用的域模型应该支持该操作。 REST 原则上是一个愚蠢的对象
rest - 通过示例了解 REST
我唯一真正接触到 REST 的想法已经通过 Ruby on Rails 的 RESTful routing .这非常适合我使用 Rails 构建的基于 CRUD 的应用程序，但因此我对 RESTful
rest - RESTful URL的好处
有什么好处 http://www.example.com/app/servlet/cat1/cat2/item 网址超过 http://www.example.com/app/servlet?c
rest - REST 服务中的建模操作
我知道以前有人问过这类问题。我有我的问题的解决方案，我想知道我是否在任何地方破坏了 REST 或 HTTP 主体。在我的系统中，我有一个名为 member 的资源。支持通常的GET/POST/PUT
rest - REST API响应部分成功
我有一个API，可以执行一些批量处理任务。假设它确实为某些资源命名。我批量传递了7个请求，其中5个更新成功，2个失败。我的问题是如何应对。使用HTTP时，我无法同时返回成功和错误。有一个部分成功
rest - RESTful 单例资源
我来自 RPC 世界，但目前正在调查使用 REST 是否适合我的项目。至于据我了解 Wikipedia RESTful 服务的基本思想是提供对集合及其各个元素的访问。在我的情况下，服务器将是一个测量
rest - Tapestry + REST
我想将REST添加到我的挂毯项目中，因此需要知道如何实现它。有什么更好的方法？谢谢。 [编辑，从答案中复制:]我必须将GET，PUT，POST和DELETE服务添加到我的挂毯应用程序中。我看到Ta
rest - RESTful 服务中的资源级别授权
让 /users/{id}成为 RESTful 服务中的资源 url。启用基本身份验证，只有经过身份验证的用户才能访问该 url。示例场景: User_1 & User_2是经过身份验证的用户，用

行者123

个人简介

我是一名优秀的程序员,十分优秀！

作者热门文章

滴滴打车优惠券免费领取

全站热门文章

首页

博学

6Ren·AI

商城

rest - 模拟HTTP上的过程调用的最佳/最RESTful方法是什么？