RESTful API 设计之错误处理

原文地址

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

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

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

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

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

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

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

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

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

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

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 175,255评论 25 709
  • 一说到REST,我想大家的第一反应就是“啊,就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束,以及如...
    时待吾阅读 8,767评论 0 19
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,347评论 19 139
  • 有时候你会发现大学考试就是这么任性 我们开卷考考学生手册 隔壁的舍友有份答案 然而我不幸的发现书里很多和答案有入 ...
    就静静听你说阅读 1,033评论 0 0
  • 祖辈风雨路 后世家国魂 多难兴邦易 万古中华情
    光影腹黑阅读 2,472评论 0 0