首页
学习
活动
专区
圈层
工具
发布

Spring Boot处理REST API错误的正确姿势

在本文中,我们就来介绍在我们使用spring boot来构建REST API时如何更好的更恰当的处理错误信息。 ?...如果你仍然不确定如何开发基本的REST API,那么你应该先去了解下有关Spring MVC的文章,或者关于构建Spring REST服务的文章。...但是, 它把处理异常的事情扔给了开发人员,需要开发人员自己来处理异常,然后向API客户端返回返回有意义的响应。 我们来看一下Spring Boot的默认做法。...它表示在REST调用期间遇到的验证问题的类。 下面,你将看到在我们实现了这里所做的改进之后生成的JSON响应的例子,仅仅是为了了解本文接下来的内容。...下面就是我们扩展后的REST调用的响应json: ?

4.1K130
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    Spring Boot REST API错误处理指南

    Boot REST API Error Handling 作者:BRUNO LEITE 翻译:雁惊寒 文章正文 API在提供错误消息的同时进行适当的错误处理,是一个非常有用的功能,因为这能让API...本文将介绍在使用Spring Boot构建REST API的时候如何进行合适的错误处理。 ? 在过去几年里,使用Spring构建REST API已经成为Java开发人员的标准方法。...让错误响应更清晰 在本文中,我们将实现一个通过REST API来检索鸟类(代表一个对象)的应用程序,代码托管在GitHub上。这个示例包含了本文描述的所有功能,以及比较多的错误处理场景。...Spring框架的MVC模块在错误处理方面提供了一些很不错的功能,但是这些功能需要由开发人员主动调用,才能返回对API客户端的有具体意义的响应。 我们来看一下这个Spring Boot默认响应的例子。...附录 译文来源:Spring Boot REST API错误处理指南-csdn

    3.9K20

    发现 Laravel 中的 api 响应时间明显过长

    背景 近期在排查网站后台页面功能时 发现,部分查询页面,明显响应时间过长(12秒),不合理 优先排查 接口运行时长 经过打印,发现代码是正常的,且时间仅需不到一秒 进一步怀疑是 VUE框架的渲染加载...,存在代码处理上的BUG 但转眼一想,当前是api接口响应的时间过长,跟框架还没有扯上关系 排查 我本地测试,使用了 apiFox,注意到返回的json信息比较大 进一步进行网上经验的搜索,发现...分析响应结果,剔除冗余数据(没必要返回的数据,那就不要了) 2....由于 WSL 的原因造成的,根据这篇文章配置过后就正常了:https://blog.csdn.net/hjxisking/article/details/104045811 附录 参考:【解决API...响应时间过长的问题】

    46210

    REST API和GraphQL API的比较

    GraphQL 为您的 API 中的数据提供完整且易于理解的描述,使客户能够准确地询问他们需要什么,仅此而已,随着时间的推移更容易发展 API,并启用强大的开发人员工具。...在典型的 REST 场景中,请求/响应如下所示: // HTTP REQUEST GET api/students/1 || api/students?...由于请求需要时间才能到达正确的数据并提供相关信息,因此开发人员必须进行多次调用。 缓存 REST API 的所有 GET 端点都可以缓存在服务器上或通过 CDN。...错误处理 每个 GraphQL 请求、成功或错误都会返回 200 状态代码。与 REST API 相比,这是一个明显的区别,在 REST API 中,每个 状态代码都指向某种类型的响应。...GraphQL 中的任何合法答案都应该是 200,包括数据和错误响应。客户端工具将有助于更有效地管理错误。错误作为特定错误对象下的响应主体的一部分进行处理

    1.2K10

    撰写合格的REST API

    稍稍总结了些经验,在这篇文章里讲讲如何撰写「合格的」REST API。 RFC一致性 REST API一般用来将某种资源和允许的对资源的操作暴露给外界,使调用者能够以正确的方式操作资源。...一般而言,如果对REST API的安全性要求比较高,那么,所有的API的所有操作均需得到授权。...客户端和服务器之间的UTC时间正常来说偏差很小,那么,一个请求携带的时间戳,和该请求到达服务器时服务器的时间戳,中间差别太大,超过某个阈值(比如说120s),那么可以认为是replay,服务器主动丢弃该请求...HTTPS HMAC Auth尽管在保证请求的一致性上非常安全,可以用于鉴别请求是否由合法的请求者发起,但请求的数据和服务器返回的响应都是明文传输,对某些要求比较高的API来说,安全级别还不够。...metrics:服务器应该收集每个请求的访问时间,到达时间,处理时间,latency,便于了解API的性能和客户端的访问分布,以便更好地优化性能和应对突发请求。

    1.8K50

    REST API和SOAP API之间的区别

    基于rest的请求的一个重要方面是,每个请求包含足够的状态来响应请求。这就允许服务器上的可见性和无状态性、扩展系统所需的属性以及识别正在发出的请求。这种状态还允许缓存特定的结果。...在成功处理之后,服务器将返回一个201个HTTP响应代码,其中有一个“Location”标头,指示新创建的资源的位置。 注意:有些人将POST视为对创建请求的对话GET。...,但是对于您控制的信息空间,它是资源生命周期中有用的一部分。 删除请求是具有幂等性的。删除请求可能会被网络故障中断。无论第一个请求是否成功处理请求,资源都应该使用204(无内容)响应代码进行响应。...它可能需要一些额外的处理来跟踪以前删除的从未存在的资源和资源(应该返回404响应代码)。一些安全策略可能要求您返回一个404响应代码,以防止出现资源的泄漏信息。...如果它们是相同的,则不处理原始请求,可以应用补丁。 Response Codes ? HTTP响应代码提供了客户机和服务器之间关于请求状态的丰富对话。

    2.4K10

    REST API和SOAP API之间的区别

    基于rest的请求的一个重要方面是,每个请求包含足够的状态来响应请求。这就允许服务器上的可见性和无状态性、扩展系统所需的属性以及识别正在发出的请求。这种状态还允许缓存特定的结果。...在成功处理之后,服务器将返回一个201个HTTP响应代码,其中有一个“Location”标头,指示新创建的资源的位置。 注意:有些人将POST视为对创建请求的对话GET。...,但是对于您控制的信息空间,它是资源生命周期中有用的一部分。 删除请求是具有幂等性的。删除请求可能会被网络故障中断。无论第一个请求是否成功处理请求,资源都应该使用204(无内容)响应代码进行响应。...它可能需要一些额外的处理来跟踪以前删除的从未存在的资源和资源(应该返回404响应代码)。一些安全策略可能要求您返回一个404响应代码,以防止出现资源的泄漏信息。...如果它们是相同的,则不处理原始请求,可以应用补丁。 Response Codes HTTP响应代码提供了客户机和服务器之间关于请求状态的丰富对话。

    1.7K20

    小站点响应时间长可能是因为带宽不足

    记本站之前响应时间问题的分析。 使用1Mbps出口带宽的站长需注意。带宽不足是很有可能的,希望这篇文章能帮你解决问题。 前言 之前网站打开的响应时间至少是5-6秒。...也参考过很多网上的优化文章,但始终没法把这个时间降下来。 最后在多次使用浏览器分析后,最终发现。有个JS文件下载时间需要3秒多。 分析 排查 在此之前,也在别的方面进行了分析。 cpu使用量不高。...因为之前买的是打折的服务器,公网是1Mbps的带宽。 特别注意:Mbps中的b是bit,我们正常说的1M是以byte为单位,1Mbps并不是认为的1M/s,实际吞吐是128KB/s....大写的B,代表Byte。小写的b代表bit。1byte=8Bit。 js文件大小有470多KB,下载吞吐是128KB/s,所以无论如何优化,这个文件下载时间都至少要3秒以上。...加上响应和渲染时间,整体页面加载时间会更长。 办法 购买带宽,需要费些钱。 使用CDN加速静态文件。 使用OSS加速静态文件。 总结 不要认为1Mbps带宽很高,其实才128KB/s的吞吐量。

    55920

    你确定你的 REST API 真的符合 REST 规范?

    RESTful API 的存在是 web 开发历史上的一个里程碑。在本文中,我将和你探讨几种节省 REST API 开发时间的方法,并给出相关的 Node.js 示例。...REST API 规范能做什么? 尽管存在上面说到的缺点,但使用合理的方法,REST 仍然是创建真正优秀 api 的一个绝佳选择。...因为你通过高质量的 API 规范实现的 api 将会是一致的,具有清晰的结构、良好的文档和高的单元测试覆盖率。 通常,REST API规范与其文档相关联。...在这篇文章中,我想分享一些例子,教你如何做到: 单元测试更简单、更可靠; 用户输入的预处理和验证; 自动序列化,确保响应一致性; 静态类型 但首先,让我们从 API 规范开始。...这将使使用你的 API 的开发人员感到轻松,并且肯定比手工填写 REST API 文档模板要好。

    79120

    优雅调试 REST API 的工具

    找到一个超级漂亮同时功能超级强,还是一个 UWP 应用的调试 REST API 工具 点击此地址 下载安装 界面截图 ?...支持对请求设置标题,同时支持分组和工作空间 如我可以对访问逗比服务器添加多个不同的 API 请求 ?...我可以对一个项目的不同功能设置不同的分组,同时还可以切换工作空间 不过切换空间是需要升级为专业版的 当然清真的是这是一个 UWP 程序 我没有收他的红包,所以不好用请到官网喷 ---- 本文会经常更新...,请阅读原文: https://blog.lindexi.com/post/%E4%BC%98%E9%9B%85%E8%B0%83%E8%AF%95-REST-API-%E7%9A%84%E5%...B7%A5%E5%85%B7.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

    1.1K10

    .Net之API响应值中枚举处理

    前言 最近在迁移一个老项目的接口到另一个新项目中,为了前端同事最小修改,所以响应的格式等最好保持不变,然后在使用中发现了老项目中如果遇到返回值的内容包含枚举,就将其转为枚举字符串内容进行返回,然后就出现了下面的修改...创建伪代码 新建一个.Net8 Api项目,然后增加一个枚举 public enum SexInfo { None, Man, Woman } 修改默认的控制器WeatherForecastController...Summary{get;set;} public SexInfo Sex{get;set;}// } 然后在Api的方法中默认写死一个性别返回值 [HttpGet(Name = "GetWeatherForecast...,API方法里面并没有做特殊处理,但是前端反馈有问题,没有返回的枚举字符串???...,不需要的就不处理,默认返回枚举值了(当然还是更建议统一下返回值) 总结 如果使用NewtonsoftJson替换了默认的序列化包方案,那么在使用其特性的时候还得注意,别引用错命令空间了。

    33200

    Flink REST API 的设计指南

    Flink REST API 介绍Flink REST API 是 JobManager 提供的 HTTP 接口,用户可以通过 GET、POST 等 REST 定义的方法,请求获取作业、JobManager...但是,由于这套系统的调用是阻塞性的,如果某个 API 长期不响应,就会持续阻塞调用方,甚至会造成 JobManager 长期卡顿,严重影响其他接口的正常请求。...非阻塞的 Flink REST API 设计要点关于拓展 Flink REST API 的方法,我们可以在 Flink 官网文档、各类技术社区文章中得到详细的指引,因而这里不再赘述基础的细节,而是更侧重于讲解遇到的一些常见的问题和解决方案...REST Handler 设计handler 是一个 REST API 接口的执行者,我们可以通过实现 handleRequest 方法来定义请求的处理逻辑。...Server,造成 Flink UI 不响应的严重后果。

    1.9K20

    Go API 多种响应的规范化处理和简化策略

    一个对外提供API接口的服务,在真正动工开发接口前一般需要先确定一下接口响应的通用格式,无论接口响应里返不返回业务数据,返回的数据是字符串、列表、对象还是其他类型都会遵照这个通用的响应格式。...既然一个项目接口的响应格式是确定的,那么在搭建项目的时候就需要我们提前封装一个通用的接口响应组件,让实现业务逻辑的代码能尽量傻瓜式地调用响应组件,由响应组件负责生成响应返回给客户端。...比如我们的API返回单一的对象或者不需要分页的列表信息时不会设置响应的分页信息,加上这个标签后接口的响应结果中就不会有pagination这个字段了。data字段也是同一个道理。...).Error("api_response_error", "err", err) r.ctx.JSON(err.HttpStatusCode(), r) } SetPagination 用来设置响应的分页信息...Error 返回错误响应,参数为我们为项目定义的AppError对象,这样响应码使用的既是AppError的Code码,在返回错误响应时会记录一条错误响应,这样即使你在处理程序中没有打错误日志,框架这里也能做个兜底

    27110

    【API架构】REST API 设计的原则和最佳实践

    这是一个完整的图表,可以轻松理解 REST API 的原理、方法和最佳实践。 现在,让我们从每个盒子的原理开始详细说明它。...REST 定义了四个接口约束:资源的识别、通过表示的资源操作、自描述消息和作为应用程序状态引擎的超媒体。 自描述消息:每条消息都包含足够的信息来描述如何处理消息。...最佳实践 现在,让我们换个角度来了解 REST 的基本最佳实践,这是每个工程师都应该知道的。 保持简单和细粒度:创建模拟系统底层应用程序域或系统数据库架构的 API。...当链接在响应中返回时,API 变得更具自我描述性。对于支持分页的响应中返回的集合,“first”、“last”、“next”和“prev”链接至少是有益的。...数据点可以是响应时间(P50、p90、P99)、状态代码(5XX、4XX 等)、网络带宽等等。 安全: - 授权/认证:对服务的授权与对任何应用程序的授权没有什么不同。

    1.8K10
    领券