江苏龙网

  1. 主页 > 生活百科 > >

API 请求失败后发生了什么？

API

当一个 API 请求没能成功的时候，客户端最好能收到一个正确的 HTTP 错误状态，例如 409 或 500，这会是一个好的开始 。不幸的是，尽管 400 Bad Request 可能就足够让我们知道错误出在哪里，但常见的情况是我们没有充足的信息来理解或解决实际遇到的问题 。
许多 API 会在响应正文中为你提供更多细节，但令人遗憾的是，每个 API 都有自己的定制风格，不同的 API，甚至在各个端点使用的报告样式都不一样 。这就需要定制的逻辑或者人工干预才能理解报告的内容 。
但这种情况并非无可避免 。先不用急着否定我 。试着想象一个更好的世界，其中每个 API 都以相同的标准格式返回错误信息 。
我们可以用一致的标识符来识别各种类型的错误，并能在任何地方轻松获得清晰的描述和元数据 。你的通用 HTTP 客户端可以自动为任何错误提供详尽细节，你的客户端错误处理机制则能轻松可靠地过滤出你所关心的特定错误，并且你能使用单组共享逻辑来处理多种 API 的常见错误 。
IETF 提出的 RFC 7807 标准希望定义一个 HTTP API 错误响应的标准格式，从而实现上述目标 。它已经开始在现实世界中得到应用了 。人们可以很容易地用它来支持现有的 API 和客户端，对于构建或使用 HTTP API 的人来说，这个标准值得关注 。
标准错误格式为什么这么有用？

API 请求失败后发生了什么？

文章插图
请不要这样做
谈这个问题前，让我们先退一步思考问题 。HTTP 的一个关键特性是标准的响应状态代码，例如 200 或 404 。正确使用这些代码可确保客户端自动理解响应的总体状态，并根据对应状态采取适当措施 。
状态代码对错误处理来说特别有用 。当请求收到意外的 500 状态时，几乎所有标准的 HTTP 客户端都会自动为你抛出一个错误，并不需要自定义规则来解析和解释各处的所有响应，从而确保意外错误能被可靠地报告，并可以在任何位置轻松处理 。
这是很好的机制，但它也有很大的局限性 。
实际上，一个 HTTP 400 响应可能表示以下任何一种情况：
  • 你的请求格式错误，无法解析
  • 你的请求意外为空，或缺少一些必需的参数
  • 你的请求有效，但仍然模棱两可，因此无法处理
  • 你的请求有效，但由于服务器错误，服务器认为请求无效
  • 你的请求有效，但请求的是完全不可能的内容
  • 你的请求已启动，但服务器拒绝了你提供的参数值
  • 你的请求已启动，但服务器拒绝了你提供的每个参数值
  • 你的请求已启动，但你的银行拒绝了其中包含的银行卡资料
  • 你的请求完成了一项购买操作，但请求的其他部分在稍后阶段被拒绝
这些全是错误，看起来都是由一个“坏”请求触发的 400 错误，但它们的内容却大相径庭 。
状态代码可帮助我们区分错误和成功状态，但没法区分得太细致 。因此，HTTP 客户端库不能在抛出的错误中包含任何有用的细节，每个 API 客户端都必须编写自定义的处理机制来解析每个失败的响应，并自行找出可能的原因和下一步应该做的操作 。
如果失败的 HTTP 请求自动抛出的异常消息不仅仅是HTTP Error: 400 Bad Request，而是 Credit card number is not valid，这样岂不更好？
只要错误有一套标准格式，上面提到的每个错误就都可以有自己的唯一标识符，并包含标准化的说明内容和指向更多细节的链接 。好处是：
  • 通用工具可以为你解析和解释错误的详细信息，而无需事先了解任何与 API 相关的信息 。
  • API 能更安全地发起错误响应，因为它知道这些错误类型标识符意味着即使解释消息发生了更改，客户端也会一直按同一种理解方式识别错误 。
  • 自定义 API 客户端可以检查错误类型以轻松处理特定情况，所有操作都以一种标准方式进行，适用于你所使用的每个 API，而无需从头开始编写 API 包装程序，也用不着每次都和 API 文档大战三百回合 。
提案的错误格式长什么样？为此，RFC7807 提出了一组用于返回错误的标准字段，以及两种将其格式化为 JSON 或 XML 的内容类型 。
格式如下：
{"type": "https://example.com/probs/out-of-credit","title": "You do not have enough credit.","detail": "Your current balance is 30, but that costs 50.","instance": "/account/12345/transactions/abc"}对于 XML 的等效格式：
<?xml version="1.0" encoding="UTF-8"?><problem xmlns="urn:ietf:rfc:7807"><type>https://example.com/probs/out-of-credit</type><title>You do not have enough credit.</title><detail>Your current balance is 30, but that costs 50.</detail><instance>/account/12345/transactions/abc</instance></problem>


推荐阅读


上一篇：碧螺春全部品牌,碧螺春怎么储存

下一篇：安吉白茶产地先容,安吉白茶网是安吉白茶原产地官方网站