RESTful API 设计之错误处理

原文地址

在本系列关于实用 REST API 设计的前几篇文章中，我谈到了简单的关联，使用HTTP? 来隐藏复杂性和可选参数，选择复数名词和具体名称等等。 查看完整系列。

RESTful API 错误处理的最佳实践呢？ 包括我自己在内的许多软件开发人员并不总是喜欢考虑异常和错误处理，但这对任何软件开发人员来说都是一个非常重要的难题，特别是对于 API 设计人员来说。

为什么好的错误处理设计对于 API 设计者来说尤其重要?

最重要的是，让你的 API 变得直观并让开发人员更有效率。

首先，开发人员通过错误来修改代码。 极限编程和更新的“测试驱动开发”模型的“测试优先”概念代表了一系列最佳实践，因为这对于开发人员来说是非常重要和自然的工作方式。

从开发人员使用 Web API 的角度来看，该接口另一端的所有内容都是黑盒子。 错误因此成为提供关于如何使用 API 的上下文和可见性的关键工具。

其次，除了在开发应用程序时，开发人员在关键时刻依靠设计良好的错误进行故障排除和解决问题，而这些问题是在他们使用 API 构建的应用程序掌握在用户手中之后。

如何在 REST 中以实用的方式思考错误

让我们来看看三个顶级API如何接近它。

[图片上传失败...(image-8c8d85-1524561897915)]