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

如何设计API返回码(错误码)?

—1— 前言 客户端请求API,通常需要通过返回码来判断API返回的结果是否符合预期,以及该如何处理返回的内容等。...API返回码的设计还是要认真对待,毕竟好的返回码设计可以降低沟通成本以及程序的维护成本。...—3— 参数约定 虽说是返回码设计,但是只有code是不行的,还要有对应的message,让人可以看懂。 参考HTTP状态码的思路,我们对错误码进行分段。...通过这样的设计,不论是程序还是人都可以非常方便的区分API的返回结果,关键是统一!...—4— 个性化Message 通常我们的Message都是写给工程师看的,但是在不同的场景下,同样的错误,可能需要给用户看到不一样的错误提示。

1.1K10

如何设计API返回码(错误码)?

一、前言 客户端请求API,通常需要通过返回码来判断API返回的结果是否符合预期,以及该如何处理返回的内容等 相信很多同学都吃过返回码定义混乱的亏,有的API用返回码是int类型,有的是string类型...,有的用0表示成功,又有的用1表示成功,还有用”true”表示成功,碰上这种事情,只能说:头疼 API返回码的设计还是要认真对待,毕竟好的返回码设计可以降低沟通成本以及程序的维护成本 二、HTTP状态码参考...,我们对错误码进行分段 返回码值 说明 0 成功 99999 系统发生未知异常 10000-19999 参数校验错误 20000-29999 A步骤执行失败 30000-39999 B步骤执行失败 通过这样的设计...,不论是程序还是人都可以非常方便的区分API的返回结果,关键是统一!...但是对于API来说,返回的信息又必须是准确的,但用户看到的就必须转译,这个转译的工作调用方可以做,但是通常API提供者来提供个性化的Message能力会更好 我们可以把转译的消息配置到数据库,并缓存到Redis

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

    08 - AWS DynamoDB batchGet() API 返回 Error

    Node.js 操作DynamoDB中的batchGet() API返回 : 返回  { ValidationException: Too many items requested for the...BatchGetItem call} 错误信息 然后就去重新阅读官网的BatchGetItemAPI文档 也可以参考 错误处理 ?...意思是 : 如您请求超过100个项目,BatchGetItem将返回ValidationException,并显示消息“Too many items requested for the BatchGetItem...第二种办法 : 文档中详细描述到,如果要求检索100个项目,但每个项目的大小为300 KB,则系统将返回52个项目(以便不超过16 MB的限制)。...它还返回一个适当的UnprocessedKeys值,以便您可以获得下一页结果。如果需要,您的应用程序可以包含自己的逻辑,以将结果页面组合到一个数据集中。

    87400

    OpenProcess打开进程返回错误的问题

    说起来也不算太难,毕竟现成的API已经提供了。我们要做的就是遍历获取每个进程的句柄,然后逐个打开就可以提取信息了。 排查结论       但是,当我逐步编写完代码并运行时,发现什么结果也没得到。...于是乎,打开调试器下了几个断点跟了进去发现:GetLastError()的返回值在遇到System Process时,会返回错误代码87。...回头一查MSDN,人家已然说明:当OpenProcess()给定的进程ID为0时,该函数会失败并且GetLastError()返回的错误代码是ERROR_INVALID_PARAMETER。...这个错误代码值就是87。...另外还说明了,当给定的进程是空闲进程(Idle Process)或CSRSS进程之一时,GetLastError()返回的错误代码是ERROR_ACCESS_DENIED,其值为5.

    3.8K100

    Flask 使用abort方法返回http错误码、http错误响应信息

    abort方法使用场景 在api开发中,当视图处理http请求的时候会出现错误的情况。当发现这种情况,如果需要返回http错误码给浏览器,或者错误响应信息,这时候就可以使用abort()方法了。...abort方法的引入 from flask import abort abort 方法示例 下面我编写一个登录的login处理视图函数,设置一个必定会错误的情况,并且分别设置返回错误码、错误响应信息的情况...= '123': abort(404) # 返回http错误码 404 503 500 return "login sucess" if __name__ == '__main...__': app.run(debug=True) 要注意,abort返回的错误码必须是标准http错误码。...可以看到返回的就是404的错误信息,下面将错误码改为500看看,如下: ? 使用abort直接返回错误码是最常用的情况,另外还有返回错误信息内容的情况。

    3.4K20
    领券