首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

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

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

7.1K31

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

对于Rest Api中要如何处理业务错误这个事情,这并不算是一个非常大的问题。事实上,对大多数架构师来说,可能很多人都不会太在意这个点。...1. http响应码 我们都知道,http响应码是有它的标准含义的,一般而言,笔者建议遵守这个标准,http响应码从1XX到5XX都有其特定的意义,但在Rest Api中,使用最多的可能还是以2XX和4XX...如上述使用的code值,当为特定值是(如0)表示业务上成功,而其它值则表示不同的业务错误。而成功的响应则放到诸如data字段中。 这种做法是否有合适与优雅?...笔者的设计 基于上述原则,笔者对此的新的设计原则如下: 规则1:2XX仅表示业务上成功处理请求 规则2:使用4XX来表示业务错误,4XX中有特别设计的,使用特别设计的,比如权限不足,使用403。...国内著名的阮一峰老师在其RESTful API 最佳实践一文中也提及过此点,但并未提及具体原因。

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

    5个REST API安全准则

    当开发REST API时,从一开始就必须注意安全方面。 REST是通过URL路径元素表达系统中特定实体的手段。REST不是一个架构,而是一种在Web上构建服务的架构风格。...REST允许通过简单的URL(而不是复杂的请求主体或POST参数)与基于web的系统交互。...当设计REST API时,不要只使用200成功或404错误。 以下是每个REST API状态返回代码要考虑的一些指南。 正确的错误处理可以帮助验证传入的请求,并更好地识别潜在的安全风险。...200 OK -回应一个成功的REST API的行动。HTTP方法可以是GET,POST,PUT,PATCH或DELETE。 400错误请求 -请求格式错误,如消息正文格式错误。...401未授权 -错误或没有提供任何authencation ID /密码。 403禁止 -当身份验证成功,但身份验证的用户没有权限使用请求的资源。 404未找到 -当请求一个不存在的资源。

    3.8K10

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

    REST本身跟http无关,但是目前http是与它相关的唯一实例。REST有着优雅、简洁的特性,本文是根据豆瓣api来谈谈自己对restful的一些理解。...把动作转换成资源 比如,上述接口中,用户收藏某本书对外暴露的接口是”/v2/book/:id/collection”,收藏动作通过post方法来展现,而不直接写着api中,collection “收藏...2xx: 请求正常处理并返回 3xx: 重定向 4xx: 客户端请求有错误 5xx: 服务端请求有错误 比如豆瓣api返回的状态码说明: 状态码 含义 说明 200 ok 请求成功 201 created...创建成功 202 accepted 更新成功 400 bad request 请求不存在 401 unauthorized 未授权 403 forbidden 禁止访问 404 not found 资源不存在...500 internal server error 内部错误 5.使用通用的错误码 通用错误码,具体产品由具体产品api给出。

    1.8K50

    flask 应用程序编程接口(API)最后一节

    这是客户端发送请求中包含无效数据的错误。...API中没有HTML或登录页面的概念,如果客户端发送带有无效或所有权凭证的请求,服务器必须拒绝请求并返回401状态码。...保存在g.current_user中,盔甲我可以从API视图函数中访问它。 错误处理函数只返回由app / api / errors.py模块中的error_response()函数生成的401错误。...401错误在HTTP标准中定义为“未授权”错误。HTTP客户端知道当它们收到此错误时,需要重新发送有效的凭证。...pC1Nu9wwyNt8VCj1trWilFdFI276AcbS" API友好的错误消息 你是否还记得,在本章的前部分,当我要求你用一个无效的用户URL从浏览器发送一个API请求时发生了什么?

    5K10

    Django Rest Framewor

    什么是RESTful REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移” REST从资源的角度类审视整个网络...400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。...401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。...410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。...500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

    1.3K20

    RESTful API 最佳实践

    7.覆盖HTTP方法 一些HTTP客户端只支持GET和POST请求。为了能够加强这些客户端的访问能力,API需要能够覆盖HTTP方法。...details about the error here"} 对于PUT、PATCH和POST的请求进行的校验错误需要嵌套多个字段。...header生效的时候用 400 Bad Request – 请求异常,比如请求中的body无法解析 401 Unauthorized – 没有进行认证或者认证非法。...当调用老版本API的时候很有用 415 Unsupported Media Type – 如果请求中的内容类型是错误的 422 Unprocessable Entity – 用来表示校验错误 429 Too...一直使用SSL的另一个优势是,加密的连接简化了用户认证的工作 – 你可以使用简单的access token,而不需要对每个API请求进行签名。 需要注意的一件事是以非SSL的形式访问API的URL。

    1.9K31

    Django Rest Framework-介绍

    ,它将分布在网络中某个节点的资源通过URL进行标识,客户端应用通过URL来获取资源的表征,获得这些表征致使这些应用转变状态 所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是...400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。...401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。...410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。...500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

    1.8K40

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

    在响应体中返回错误详情 当API服务器处理错误时,将错误详细信息包含在JSON主体中可以帮助使用者进行调试,这是是非常方便的,如果您还能说明哪些字段受到了错误的影响,那就更好了!...特别关注 HTTP 状态码 这一点非常重要,如果你从这篇文章中只记住一件事,那可能就是它了。 你的API最糟糕的事情莫过于返回一个带有200 OK状态码的错误响应。...了解401未授权和403禁止之间的区别 如果我每看到一次开发人员甚至有经验的架构师搞砸这个问题就能得到一个25美分硬币……在处理REST API中的安全错误时,很容易弄混错误是与身份验证还是授权(又称权限...根据不同情况,以下是我的备忘单,用于了解我正在处理什么问题: 消费者没有提供身份验证凭据吗?他们的SSO令牌是否无效/超时? 401 未授权。...如果资源以某种方式已经存在,但这不应被视为错误。 13. 使用专门针对REST API的网络框架 作为最后一个最佳实践,让我们讨论这个问题:如何在您的API中实际应用最佳实践?

    45240

    python测试开发django-61.权限认证(permission)

    django rest framework权限和认证有四种方式: BasicAuthentication 此身份验证方案使用HTTP基本身份验证,根据用户的用户名和密码进行签名。...permission权限认证 权限检查通常使用request.user和request.auth属性中的身份验证信息来确定是否应允许传入请求。...当权限检查失败时,将根据以下规则返回HTTP 403 Forbidden或HTTP 401 Unauthorized: 如果收到的请求身份验证通过,但是权限验证失败,则返回HTTP 403 Forbidden...请求头,则返回HTTP 401 Unauthorized 权限级别也有四种 AllowAny 允许所有用户 IsAuthenticated 表示仅仅允许身份验证通过的用户访问,其他用户无法访问。...如果token错误,或者没有token就会出现401 Unauthorized ?

    2K40

    10个有关RESTful API良好设计的最佳实践

    通常我们为Web API使用RESTful设计,REST概念分离了API结构和逻辑资源,通过Http方法GET, DELETE, POST 和 PUT来操作资源。   ...使用Http状态码处理错误 如果你的API没有错误处理是很难的,只是返回500和出错堆栈不一定有用 Http状态码提供70个出错,我们只要使用10个左右: 200 – OK – 一切正常 201 – OK...– 新的资源已经成功创建 204 – OK – 资源已经成功擅长 304 – Not Modified – 客户端使用缓存数据 400 – Bad Request – 请求无效,需要附加细节解释如 "...JSON无效" 401 – Unauthorized – 请求需要用户验证 403 – Forbidden – 服务器已经理解了请求,但是拒绝服务或这种请求的访问是不允许的。...500 – Internal Server Error – API开发者应该避免这种错误。

    64350

    常见状态码

    5xx:服务器端错误–服务器未能实现合法的请求 状态码详解 code 描述 详细解释 200 成功 成功 400 错误请求 该请求是无效的,详细的错误信息会说明原因 401...App Secret 错误 App Key 与 App Secret 不匹配 401 1002 参数错误 参数错误,详细的描述信息会说明 400 1003 无 POST 数据 没有 POST 任何数据...400 1004 验证签名错误 验证签名错误 401 1005 参数长度超限 参数长度超限,详细的描述信息会说明 400 1006 App 被锁定或删除 App 被锁定或删除 401...25101 消息撤回时,参数错误。 29106 未关注此公众号。 29201 无效的公众号。(由会话类型和 Id 所标识的公众号会话是无效的)。...建立连接的临时错误码,SDK 会做好自动重连,开发者无须处理。 31004 Token 无效。Token 无效一般有以下两种原因。

    2.3K30

    Restful API设计规范

    HTTP Method rest的定义,第一条叫做资源定位,如果还不理解,那让我们再想想URL的定义,叫做统一资源定位符,也就是说url是用来表示资源在互联网上的位置的,所以说在url中不应该包含动词,...400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。...401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。...410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。...500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。 最后推荐大家github的api文档: ? 完毕!!!

    1.4K30

    REST API 安全设计指南

    rest_api是从url获取的为/rest/v1/interface/eth0,最后计算sign值,完之后和url中的sign值做校验。...限定num位置为整数等,如果不是参数则直接返回非法参数,设定一个url清单,不在不在url清单中的请求直接拒绝,这样能防止开发中的api泄露。...rest api接口一般会用到GET,POST,PUT,DELETE,未实现的方法则直接返回方法不允许,对于POST,PUT方法的数据采用json格式,并且在进入逻辑前验证是否json,不合法返回json...有一个统一的出错接口,对于400系列和500系列的错误都有相应的错误码和相关消息提示,如401:未授权;403:已经鉴权,但是没有相应权限。如不识别的url: ? 错误的请求参数 ?...9、其他注意事项 (1)请求数据,对于POST,DELETE方法中的数据都采用json格式,当然不是说rest架构不支持xml,由于xml太不好解析,对于大部分的应用json已经足够,近一些的趋势也是json

    3.4K80

    REST初体验

    最近开发学习中用到了REST API,处于懵懂,此REST,非彼rest,不是我们理解的含义,这是一种缩写,REpresentational State Transfer,再具体一些就是Resource...一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。...400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。...401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。...500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

    84120

    我们必须要知道的RESTful服务最佳实践

    URL API请求授权 1.REST的来源 REST:Representational State Transfer(表象层状态转变),如果没听说过REST,你一定以为是rest这个单词,刚开始我也是这样认为的...中 https://example.com/api/users POST 添加新的用户 4....5**(服务器错误)这些状态代码表示服务器在尝试处理请求时发生内部错误。 这些错误可能是服务器本身的错误,而不是请求出错。...HTTP Method 详细解释 返回状态码 GET 获取对象或集合 200成功、401没有授权、403访问禁止、404没有资源、参数错误、406请求格式不正确、410资源被删除、500服务器内部错误...POST 新增一条数据 201创建成功、422新增数据验证错误、(401、403、404、406、500) DELETE 删除一条数据 204删除成功、(401、403、404、406、500) PATCH

    1.3K30

    RESTFUL API 安全设计指南

    一、REST API 简介 REST的全称是REpresentational State Transfer,表示表述性无状态传输,无需session,所以每次请求都得带上身份认证信息。...,这样能防止开发中的api泄露。...rest api接口一般会用到GET,POST,PUT,DELETE,未实现的方法则直接返回方法不允许,对于POST,PUT方法的数据采用json格式,并且在进入逻辑前验证是否json,不合法返回json...有一个统一的出错接口,对于400系列和500系列的错误都有相应的错误码和相关消息提示,如401:未授权;403:已经鉴权,但是没有相应权限。...九、其他注意事项 (1)请求数据,对于POST,DELETE方法中的数据都采用json格式,当然不是说rest架构不支持xml,由于xml太不好解析,对于大部分的应用json已经足够,近一些的趋势也是json

    1.6K20

    RESTful API 设计最佳实践

    请求的HTTP body中包含要更新的属性值(21号员工的新名称“Bruce Wayne”)。 REST服务器更新ID为21的员工名称,并使用HTTP状态码200表示更改成功。...- 如果客户端发生错误(例如客户端发送无效请求或未被授权) 5xx – 服务器错误 - 如果服务器发生错误(例如,尝试处理请求时出错) 参考维基百科上的HTTP状态代码。...通常会用到一下几个: 2xx:成功3xx:重定向 4xx:客户端错误 5xx:服务器错误 200 成功301 永久重定向400 错误请求500 内部服务器错误201 创建304 资源未修改401未授权...在响应参数中添加浏览其它API的链接 理想情况下,不会让客户端自己构造使用REST API的URL。让我们思考一个例子。 客户端想要访问员工的薪酬表。...如果客户端完全依靠links中的字段获得薪资表,你更改了API,客户端将始终获得一个有效的URL(只要你更改了link字段,请求的URL会自动更改),不会中断。

    1.3K60

    REST API安全设计指南

    ,途中的 rest_api 是从 url 获取的为/rest/v1/interface/eth0,最后计算 sign 值,之后和 url 中的 sign 值做校验。...,这样能防止开发中的 api 泄露。...REST api 接口一般会用到 GET、POST、PUT、DELETE,未实现的方法则直接返回方法不允许,对于 POST、PUT 方法的数据采用 json 格式,并且在进入逻辑前验证是否 json,不合法则返回...有一个统一的出错接口,对于 400 系列和 500 系列的错误都有相应的错误码和相关消息提示,如 401:未授权;403:已经鉴权,但是没有相应权限。...请求数据,对于 POST、DELETE 方法中的数据都采用 json 格式,当然不是说 rest 架构不支持 xml,由于 xml 不太好解析,对于大部分的应用,json 已经足够。

    2K20
    领券