文档建议反馈控制台
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
发布

SpringBoot中REST API的错误异常处理设计

RESTful API中的异常Exception处理有两个基本要求，需要明确业务意义的错误消息以及hhtp状态码。良好的错误消息能够让API客户端纠正问题。...Restful API错误/异常设计 在RESTful API中设计异常处理时，最好在响应中设置HTTP状态代码，这样可以表示客户端的请求为什么会失败的原因。...2. error_code表示REST API特定的错误代码。此字段有助于传递API /业务领域中特定信息。比如类似Oracle错误ORA-12345 3. message字段表示人类可读的错误消息。...现在我们可以定义一下我们的错误类信息的代码，然后把这个对象嵌入ResponseEntity中返回。...在这篇文章中，我们介绍了实现Spring REST异常处理的不同选项。 为REST API构建一个良好的异常处理工作流是一个迭代和复杂的过程。

8.3K31

技术随笔：Rest Api设计中处理业务错误的一些思考

对于Rest Api中要如何处理业务错误这个事情，这并不算是一个非常大的问题。事实上，对大多数架构师来说，可能很多人都不会太在意这个点。...1. http响应码 我们都知道，http响应码是有它的标准含义的，一般而言，笔者建议遵守这个标准，http响应码从1XX到5XX都有其特定的意义，但在Rest Api中，使用最多的可能还是以2XX和4XX...事实上，我们看下4XX这个类别，可以明显感知到，它本身就包含了一些业务错误，比如权限不够，被禁止，资源不存在等，这些本身也可以算到业务错误的一部分。...而没有特别设计的，则考虑使用400 规则3：对于4XX的响应，再额外使用业务错误码来表示更进一步的业务上的错误含义 规则4：使用字符来表示业务错误描述码。...国内著名的阮一峰老师在其RESTful API 最佳实践一文中也提及过此点，但并未提及具体原因。

2.3K10
    • 您找到你想要的搜索结果了吗？
    是的
    没有找到

    ApacheCN PHP 译文集 20211101 更新

    ，这是一种进化 六、用 Lumen 照亮 RESTful Web 服务 七、改进 restfulweb 服务 八、API 测试——闸门上的防护装置 九、微服务 函数式 PHP 零、序言 一、PHP 中的一等函数...十一、提取动作逻辑到控制器 十二、替换类中的包含 十三、公共和非公共资源分开 十四、将 URL 路径与文件路径解耦 十五、删除页面脚本中的重复逻辑 十六、添加依赖注入容器 十七、结论 十八、附录 A：...典型遗留页面脚本 十九、附录 B：网关前的代码 二十、附录 C：网关后的代码 二十一、附录 D：事务脚本后的代码 二十二、附录 E：采集表示逻辑前的代码 二十三、附录 F：采集表示逻辑后的代码 二十四、...数据对象：第一步 三、错误处理 四、预备语句 五、处理行集 六、高级 PDO 使用 七、高级示例 八、附录 A：PHP5 中 OOP 介绍 Magento PHP 开发指南 零、序言 一、了解和建立我们的开发环境...二、开发人员的 Magento 基础知识 三、ORM 和数据收集 四、前端开发 五、后端开发 六、Magento API 七、测试和质量保证 八、部署与分发 九、附录 A：你好，Magento PHP

    4.7K10

    RESTful API 最佳实践

    ，也可使用动词，例如：search没有对应的HTTP方法，可以在路径中使用search，更加直观； URI中的名词表示资源集合，使用复数形式； 虽然/在URI中表达层级，但是避免为了追求REST导致层级过深...错误的表现形式应该跟其他资源保持一致，只是用一些自己的字段。 API应该一直返回合理的HTTP状态码。API错误一般情况下分成两类：代表客户端错误的400系列状态码和代表服务端错误的500系列状态码。...API至少把所有400系列错误统一用易读的JSON格式来展示。如果可能（比如，如果负载均衡和反向代理能够创建自定义错误内容的话），500系列的状态码也这么弄。...header生效的时候用 400 Bad Request – 请求异常，比如请求中的body无法解析 401 Unauthorized – 没有进行认证或者认证非法。...当然，这种基于token来进行基本认证的方法只能当用户从API管理后台拷贝了一个token到自己的代码中才行。如果搞不到token，只能使用OAuth 2来把安全token传递给第三方。

    2.2K31

    如何设计出优秀的Restful API？

    REST的概念是将API结构分离为操作和资源。使用HTTP方法GET、DELETE、POST和PUT操作资源。 设计糟糕的REST API = 浪费时间！...2 REST API里面的术语 Resource（资源）是指代表某种东西的对象，它具有一些与之相关的数据，并且可以有一组方法对其进行操作。 例如。...6 使用HTTP状态码 当客户端通过API向服务器发出请求时，客户端应该知道反馈，无论是失败，成功还是请求错误。 HTTP状态代码是一系列标准化代码，针对http请求的可能会发生的各种情况。...服务器应始终返回正确的状态代码。 很多人喜欢把错误信息放在返回值中，典型的Code和Message，其实比较Low。...因此无需再次传输相同的数据。 4xx（客户端错误类别） 这些状态代码表示客户端已提出错误请求。 400 Bad Request表示未处理客户端的请求，因为服务器无法理解客户端要求的内容。

    1.4K10

    基于 MVC的 RESTful风格的实现

    例如，在一个获取设备资源列表的 GET请求中，方法信息是 GET，作用域信息是URI中包含的对设备资源的过滤、分页和排序等条件 良好的 REST API不需要任何文档 1.1 REST风格资源路径 REST...username=xiuer&id=1 1.2 HTTP方法 GET用于读取、检索、查询、过滤资源 PSOT用于创建一个资源 PUT用于修改、更新资源、创建客户端维护主键信息的资源 DELETE用于删除资源...资源地址和 HTTP方法结合在一起就可以实现对资源的完整定位 1.3 RESTful风格 API设计 上文讲述了通过HTTP方法和资源路径对服务器的一个资源进行定位的过程 接下来看一个REST风格 API...，而不进行视图跳转 2.2返回 HTTP状态码 REST风格 API一个最鲜明的特点通过返回对应的 HTTPStatus来判断客户端的操作是否完成 下面是spring中关于 Http状态码描述的枚举类，...MVC实现 REST代码实现 3.1实例环境 JDK1.8 maven3.60 tomcat9 3.2 API设计 URI Description Response HTTPStatus GET/users

    1K10

    我是如何根据豆瓣api来理解Restful API设计的

    REST本身没有创造新的技术、组件或服务，它的理念就是在现有的技术之上，更好的使用现有的 web规范。用REST规范的web服务器，能够更好的展现资源，客户端能够更好的使用资源。...每个资源都由URI/ID标识。REST本身跟http无关，但是目前http是与它相关的唯一实例。REST有着优雅、简洁的特性，本文是根据豆瓣api来谈谈自己对restful的一些理解。...用来过滤资源，比如？limit=10 :指定返回10条记录。 不使用无意义的字符串、数字，要做到简洁。 3.正确使用method get -只用做资源的读取。 post-通过用作创建一个新的资源。...把动作转换成资源 比如，上述接口中，用户收藏某本书对外暴露的接口是”/v2/book/:id/collection”,收藏动作通过post方法来展现，而不直接写着api中，collection “收藏...500 internal server error 内部错误 5.使用通用的错误码 通用错误码，具体产品由具体产品api给出。

    2.3K50

    RESTful API 主流API风格

    RESTful 入门 一、什么是Restful REST 是 Representational State Transfer 的缩写，如果一个架构符合 REST 原则，就称它为 RESTful 架构 RESTful...宾语：URL 应该全部使用名词复数，可以有例外，比如搜索可以使用更加直观的 search 。 过滤信息（Filtering） 如果记录数量很多，API应该提供参数，过滤返回结果。 ?...GET: 200 OK POST: 201 Created PUT: 200 OK PATCH: 200 OK DELETE: 204 No Content 上面代码中，POST...HTTP/1.1 303 See Other Location: /api/orders/12345 4xx 状态码 4xx 状态码表示客户端错误，主要有下面几种： 400 Bad Request：服务器不理解客户端的请求...5xx 状态码 5xx状态码表示服务端错误。一般来说，API 不会向用户透露服务器的详细信息，所以只要两个状态码就够了。

    3.6K11

    REST API 最佳实践

    在这篇文章中，我将带你了解创建 REST API 时需要遵循的一些最佳实践。这将帮助你创建最好的 API，并使你的 API 用户使用起来更容易。 0.什么是 REST API？...5.用过滤、排序和分页请求数据 有时，API 的数据库可能非常大。如果发生这种情况，从这样的数据库中检索数据可能非常缓慢。 过滤、排序和分页都是可以在 REST API 的集合上执行的操作。...12.使用 HTTP 状态码 你应该在对你的 API 请求的响应中始终使用常规的 HTTP 状态代码。这将帮助你的用户知道发生了什么——请求是否成功，或者是否失败，或者其他情况。...表示永久移动 4XX 客户端错误，如 400 表示错误的请求，404 表示未找到资源 5XX 服务器端错误，如 500 表示内部服务器错误 13.提供有用的错误消息 除了提供恰当的HTTP状态代码外...文档应包含： API 的相关端点 端点的示例请求 在几种编程语言中的实现 不同错误的消息列表及其状态代码 你可以用于 API 文档的最常用工具是 Swagger。

    2.8K20

    如何设计好的RESTful API

    ，但是不能快速从接口 URL 的定义中明确该接口的含义，需要进一步读代码确认 URL中的英文单词使用五花八门，搜索某个接口不知道具体的关键字 请求方法动词如 POST GET 随意使用 完成当前业务接口对接...资源明显，其他过滤条件也更容易扩展，比如 /posts?...过滤/分页/排序 实际的业务场景中会经常对请求资源做条件筛选，分页显示，以及排序，我们不要为这些业务要求创建不同步的 API，我们应该尽量保持 URL 的信息简单，只需添加查询条件参数来实现上述功能，...published=true 上述两种方式都可以实现资源的过滤 分页 GET /users?...） 4xx 状态码 4xx 状态码表示客户端的错误，主要有以下几种： 400BadRequest：服务器不理解客户端的请求，未做任何处理 401Unauthorized：用户未提供身份验证凭据，或者没有通过身份验证

    2.2K20

    RESTful API 设计指南

    在目前主流的三种Web服务交互方案中，REST相比于SOAP（Simple Object Access protocol，简单对象访问协议）以及XML-RPC更加简单明了，无论是对URL的处理还是对Payload...在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。...一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。...API应该提供参数，过滤返回结果。 下面是一些常见的参数。 https://api.example.com/v1/zoos?...400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。

    1.1K50

    RESTful API基本介绍

    在目前主流的三种Web服务交互方案中，REST相比于SOAP（Simple Object Access protocol，简单对象访问协议）以及XML-RPC更加简单明了，无论是对URL的处理还是对Payload...在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。...一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。...API应该提供参数，过滤返回结果。 下面是一些常见的参数。 https://api.example.com/v1/zoos?...400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。

    94730

    前端要知道的RESTful API架构风格

    服务端少了很多代码自然就简单了。 可靠性。可靠性是指一个软件的稳定程度，以及它从依次故障中恢复正常的能力。为什么说它提升了可靠性呢？...按需代码（Code-On-Demand 可选） 这是一条可选的限制，也不是很重要。所谓按需代码是指客户端可以下载运行服务端传来的代码（比如JS），按需代码的好处是通过减少一些功能，简化了客户端。...REST整个都是围绕资源展开的，不像其它一些风格可能是以动词形式，REST里面的资源都是一些名词，不仅如此，每个资源都可以被URI唯一的标识。 通过表述对资源执行操作。...400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。...为集合提供过滤、排序、分页等功能。 用查询字符串或HTTP首部进行内容协商，指定返回结果的数据格式。 及时更新文档，每个接口都有对应的说明。 你的公司使用的是RESTful API吗？

    1.2K30

    REST API 设计最佳实践：如何构建、设计和使用 API ？

    但是，我主要接触的是REST，这是一种基于资源的API和Web服务开发架构风格。在我的职业生涯中有很大一部分时间都参与了构建、设计和使用API 的项目。...在响应体中返回错误详情 当API服务器处理错误时，将错误详细信息包含在JSON主体中可以帮助使用者进行调试，这是是非常方便的，如果您还能说明哪些字段受到了错误的影响，那就更好了！...特别关注 HTTP 状态码 这一点非常重要，如果你从这篇文章中只记住一件事，那可能就是它了。 你的API最糟糕的事情莫过于返回一个带有200 OK状态码的错误响应。...了解401未授权和403禁止之间的区别 如果我每看到一次开发人员甚至有经验的架构师搞砸这个问题就能得到一个25美分硬币……在处理REST API中的安全错误时，很容易弄混错误是与身份验证还是授权（又称权限...如果资源以某种方式已经存在，但这不应被视为错误。 13. 使用专门针对REST API的网络框架 作为最后一个最佳实践，让我们讨论这个问题：如何在您的API中实际应用最佳实践？

    2.2K40

    Django Rest Framework-介绍

    什么是RESTful REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移” REST从资源的角度类审视整个网络...，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态 所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是...REST区别与其他架构风格的最本质属性 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）...：在服务器新建一个资源 PUT ：在服务器更新资源（客户端提供改变后的完整资源） PATCH ：在服务器更新资源（客户端提供改变的属性） DELETE ：从服务器删除资源 过滤，通过在url上传参的形式传递搜索条件...400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。

    2.2K40

    除了Shopify还有哪些好用的独立站建站工具？

    技术架构创新 Saleor基于Python和GraphQL开发，API响应速度比传统REST快3倍，适合高并发场景（如秒杀活动）。...品推建站系统的"海关数据看板"可实时显示目标市场税率、清关要求，降低外贸合规风险 Saleor的GraphQL架构使单次API请求可获取商品、库存、促销信息，减少80%的数据请求量三、成本与扩展性对比费用结构...企业市场提供ERP/CRM深度集成方案 定制开发：Fixon只需拖拽即可完成建站，建站效率比传统CMS提升40%，适合需要快速迭代的企业 技术要求： 低门槛：Wix/Fixon（无需代码） 中门槛...+本地仓储API） B2B企业 中小型：Shift4Shop（内置报价系统）或WooCommerce（会员等级管理） 大型：Magento（多商家市场功能）或Saleor（API级权限控制）五、未来趋势与选择建议技术演进方向...Fixon凭借其AI驱动和全栈能力，正在改写传统建站规则，特别适合追求内容营销+数据驱动的新兴品牌。而传统巨头如BigCommerce和Magento仍保持企业级市场的统治地位。

    2.2K00
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

      Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有

      深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 粤公网安备44030502008569号

      腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号

      领券