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

Spring Boot REST API错误处理指南

本文将介绍在使用Spring Boot构建REST API的时候如何进行合适的错误处理。 ? 在过去几年里,使用Spring构建REST API已经成为Java开发人员的标准方法。...让错误响应更清晰 在本文中,我们将实现一个通过REST API来检索鸟类(代表一个对象)的应用程序,代码托管在GitHub上。这个示例包含了本文描述的所有功能,以及比较多的错误处理场景。...比较常见的情况是:http返回码400表示BAD_REQUEST,例如,客户端发送了格式不正确的字段(如无效的电子邮件地址)。 timestamp属性保存了发生错误的日期时间。...这用于表示在单个调用中出现的多个错误。比如,校验的时候有多个字段验证失败。用ApiSubError类进行封装。...它使得单个ExceptionHandler应用于多个控制器上。这样我们可以在一个地方定义如何处理这样的异常,当ControllerAdvice覆盖的类抛出异常时,这个处理程序就会被调用。

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

    【愚公系列】2022年04月 Python教学课程 77-DRF框架之异常

    文章目录 一、DRF框架自带异常 二、自定义异常 一、DRF框架自带异常 REST 框架的视图处理各种异常,并处理返回适当的错误响应。 处理的异常包括: 在 REST 框架中定义的异常。...detail 例如,以下请求: DELETE http://api.example.com/foo/bar HTTP/1.1 Accept: application/json 可能会收到一个错误响应,指示该资源上不允许使用该方法...示例验证错误如下所示: HTTP/1.1 400 Bad Request Content-Type: application/json Content-Length: 94 {"amount": ["...' } 请注意,将仅对引发的异常生成的响应调用异常处理程序。...它不会用于视图直接返回的任何响应,例如在序列化程序验证失败时由泛型视图返回的响应。HTTP_400_BAD_REQUEST

    1.4K40

    快速学习-RESTFul设计风格

    常见状态码: 状态码 含义 说明 200 OK 操作成功, 并返回数据 201 CREATED 新建成功 204 NO CONTENT 删除成功 400 BAD REQUEST 请求语法错误 403 Forbidden...(bad request)- 指代坏请求(如,参数错误) 404 (not found)- 资源不存在 406 (not acceptable)- 服务端不支持所需表示 500 (internal...(bad request)- 指代坏请求 404 (not found)- 资源不存在 406 (not acceptable)- 服务端不支持所需表示 409 (conflict)- 通用冲突...(bad request)- 指代坏请求 404 (not found)- 资源不存在 406 (not acceptable)- 服务端不支持所需表示 409 (conflict)- 通用冲突...(bad request)- 指代坏请求 404 (not found)- 资源不存在 409 (conflict)- 通用冲突 500 (internal server error)- 通用错误响应

    1.6K20

    聊一聊接口测试如何设计有效的错误响应测试用例

    输入验证错误测试点:必填字段缺失:移除必填参数,验证返回 400 Bad Request 及错误描述(如 "username is required")。...依赖条件不满足:下单时库存不足,返回 400 及明确提示(如 "Insufficient stock")。...正确的 HTTP 状态码遵循 REST 规范:4xx:客户端错误(如 400, 401, 404)。5xx:服务端错误(如 500, 503)。c....page=1&size=abc(分页查询商品)场景:size参数传入非数字字符串预期响应:状态码:400 Bad Request响应体:json{  "code": "INVALID_PARAM_TYPE...city=Beijing(调用天气API)场景:第三方天气服务未响应(超时3秒)预期响应:状态码:504 Gateway Timeout响应体:json{  "code": "THIRD_PARTY_API_TIMEOUT

    81610

    Spring 异常处理@ExceptionHandler

    @ExceptionHandler 我们可以使用 @ExceptionHandler 来注解方法,当发生指定异常时,Spring 将自动调用这些方法。...一个返回 400 状态码的最简单的异常处理器可能是这样的: @ResponseStatus(HttpStatus.BAD_REQUEST) @ExceptionHandler(CustomException1...它还将允许我们在 REST API 中实现一个统一的异常处理机制。 5.1....处理现有异常 在典型的 REST 实现中,我们经常要处理以下几种异常: AccessDeniedException 发生在经过身份验证的用户试图访问他没有足够权限访问的资源时。...结论 在本文中,我们讨论了几种为 Spring REST API 实现异常处理机制的方法。我们根据其使用场景对它们进行了比较。 我们应该注意到,在一个应用中可以结合使用不同的方法。

    41710

    drf之请求、响应、视图

    _BAD_REQUEST = 400 HTTP_401_UNAUTHORIZED = 401 HTTP_402_PAYMENT_REQUIRED = 402 HTTP_403_FORBIDDEN = 403...提供的关于序列化器使用的属性与方法 属性:serializer_class  指明视图使用的序列化器 方法: get_serializer_class(self) : 当出现一个视图类中调用多个序列化器时...同时也提供partial_update(request, *args, **kwargs)方法,可以实现局部更新。 成功返回200,序列化器校验数据失败时,返回400错误。...视图集只在使用as_view()方法的时候,才会将action 动作与具体请求方式对应上。...GenericViewSet就帮助我们完成了这样的继承工作,继承自GenericAPIView与ViewSetMixin,在实现了调用as_view()时传入字典(如{'get':'list'})的映射处理工作的同时

    2.7K20

    django-rest-framework框架学习

    中很著名的一个框架是django-rest-framework,帮我们减少了很多工作量,尤其在序列化与反序列化成我们需要的格式帮了我们省了很多事 在这里就记录一下个人的学习过程 django-rest-framework...api类,只需要继承rest_framework中generics中的某个类,重写我们需要的方法实现合适的逻辑即可 在urls.py中配置所需要的url 一组api的demo 创建一个model 在创建好的...请注意,使用超链接的API时,您需要确保双方的API意见和串行类设置查找字段,如果你需要使用一个自定义值 在get_queryset()中实现的是按照name查询的,因为很多时候客户端并不知道自己的id...,在显示学生信息的基础上,我们还想显示该名学生的成绩 所以新的model.py为 from django.db import models class Student(models.Model):..._BAD_REQUEST) ''' def list(self, request, *args, **kwargs): print('list') return

    1.9K10

    RESTful API 最佳实践

    例子:在HTTP中使用GET方法通常用于从服务器获取资源,无论调用多少次产生的额外效果都是从服务器获取资源,所以GET具有幂等性;而POST方法通常用于提交数据在服务器上创建一个资源,由于最终创建的结果每次都是不同的...URI 应该将API部署在专用域名之下:https://api.example.com 不用大写 用中杠-不用下杠_; 参数列表要encode; URI中不应该出现动词,动词应该使用HTTP方法表示,但是如果无法表示...API应该一直返回合理的HTTP状态码。API错误一般情况下分成两类:代表客户端错误的400系列状态码和代表服务端错误的500系列状态码。API至少把所有400系列错误统一用易读的JSON格式来展示。...Bad Request – 请求异常,比如请求中的body无法解析 401 Unauthorized – 没有进行认证或者认证非法。...在进行分页查询时可以返回下一页的URI,如果没有说明服务器已经取到最后一条数据了,客户端可以减少不必要的请求以及URI的构造,建议在分页的情况下使用。

    2.2K31

    REST API和GraphQL API的比较

    RESTful API 使用 HTTP 方法在处理数据时执行 CRUD(创建、读取、更新和删除)过程。 为了促进缓存、AB 测试、身份验证和其他过程,标头向客户端和服务器提供信息。...在典型的 REST 场景中,请求/响应如下所示: // HTTP REQUEST GET api/students/1 || api/students?...动图 )在 GraphQL 和 REST 之间进行选择时要考虑的事项 安全 REST API 使用 HTTP,允许使用传输层安全性进行加密,并提供多种 API 身份验证选项。...缓存 REST API 的所有 GET 端点都可以缓存在服务器上或通过 CDN。它们也可以由客户端存储以供经常使用,并由浏览器缓存。...Status Code REST GraphQL 200 Ok Ok 400 Bad Request - 401 Unauthorized - REST API 的错误可以有 200 以外的任何代码,

    1.7K10
    领券