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

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

—1— 前言 客户端请求API,通常需要通过返回码来判断API返回的结果是否符合预期,以及该如何处理返回的内容等。...API返回码的设计还是要认真对待,毕竟好的返回码设计可以降低沟通成本以及程序的维护成本。...参考HTTP状态码的思路,我们对错误码进行分段。 通过这样的设计,不论是程序还是人都可以非常方便的区分API的返回结果,关键是统一!...但是对于API来说,返回的信息又必须是准确的,但用户看到的就必须转译,这个转译的工作调用方可以做,但是通常API提供者来提供个性化的Message能力会更好。...—5— 返回信息的统一处理 有了统一的code,我们就可以通过Nginx或者APM工具统计API请求Code数量及分布信息。 我们可以根据单位时间内99999的数量来做API的异常告警。

76510

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

一、前言 客户端请求API,通常需要通过返回码来判断API返回的结果是否符合预期,以及该如何处理返回的内容等 相信很多同学都吃过返回码定义混乱的亏,有的API用返回码是int类型,有的是string类型...,有的用0表示成功,又有的用1表示成功,还有用”true”表示成功,碰上这种事情,只能说:头疼 API返回码的设计还是要认真对待,毕竟好的返回码设计可以降低沟通成本以及程序的维护成本 二、HTTP状态码参考...虽说是返回码设计,但是只有code是不行的,还要有对应的message,让人可以看懂 字段 类型 说明 code int 返回码 message string 返回码说明 参考HTTP状态码的思路,我们对错误码进行分段...但是对于API来说,返回的信息又必须是准确的,但用户看到的就必须转译,这个转译的工作调用方可以做,但是通常API提供者来提供个性化的Message能力会更好 我们可以把转译的消息配置到数据库,并缓存到Redis...或者API本机 application_id code message 100001 20001 很抱歉,您有一个正在进行中的订单,请到我的订单列表中处理。

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

腾讯会议API错误码200003定位分析

使用腾讯会议API&SDK的企业越来越多,本文分析常见的错误码问题排查。...背景 腾讯会议(Tencent Meeting,TM)Rest API 是为参与腾讯会议生态系统建设的合作方开发者接入并访问腾讯会议资源提供的一组工具,是访问腾讯会议 SaaS 服务的入口。...合作伙伴可以通过腾讯会议API 进行二次开发,例如创建一个会议,修改会议,查询会议信息等。...若 Rest API 调用失败,返回的 HTTP StatusCode 不为200时,响应体为错误信息,包含错误码和详细的错误信息。 服务错误,HTTP Status Code统一返回500。...API请求错误,HTTPStatus Code 统一返回400。 详细的错误信息可解析返回消息体中的JSON 串。

2.5K91

gRPC: 如何设计 RPC 错误码

[up-b65a79b4f77bc4d4f32eec10351e2e73814.png] 设计一个合理的 API 是一件不容易的事情,同时,API 还会产生各种不同的错误。...为了能让 API 使用者对于 API 的错误有一个清晰的视图,定义一个标准的 RPC 错误类型是非常重要的事情。 考虑范围 一个合理的 RPC 错误,需要考虑如下几个方面。...包含错误码,错误信息 错误信息可扩展 考虑可读性 可解析性,即,用户可通过代码解析错误码,并采取有效行为 避免内部错误益处,例如,Nil point error RPC 错误码结构 [up-3233efc7329c9e7d30d375dd6363d5bc459...rookie-ninja/rk-grpc/boot" "github.com/rookie-ninja/rk-common/error" "github.com/rookie-ninja/rk-demo/api..., "details":[] } } 给 GRPC 发送请求 $ grpcurl -plaintext localhost:8080 api.v1.Greeter.Greeter

2.2K70

令人头疼的错误码(上)

它既应说明错误,又应提供可行的解决方案,特别注意,谷歌强调错误消息不属于 API 协议,它们随时都会更改,应用代码不得严重依赖于错误消息。...在编写错误消息时请考虑以下准则: 不要假设用户是您 API 的专家用户。用户可能是客户端开发人员、操作人员、IT 人员或应用的最终用户。...如果可能,应构建错误消息,以便技术用户(但不一定是 API 开发人员)可以响应错误并改正。 确保错误消息内容简洁。...details:客户端代码可用于处理错误的其他错误信息,Google API 为错误详细信息定义了一组标准错误负载, 涵盖了对于 API 错误的最常见需求,例如配额失败和无效参数。...It has an extra // field `status` for backward compatibility with Google API Client Library.

1.8K20

服务器堡垒机错误码110的原因?错误码110如何解决?

很多使用堡垒机来连接外网的企业,在使用过程中都可能会遇到各种各样的报错,而错误码110是报错中经常出现的代码,很多朋友不知道为什么会出现这样的错误码,那么服务器堡垒机错误码110的原因是什么?...错误码110如何解决呢? 服务器堡垒机错误码110的原因 当服务器堡垒机在连接远程服务器时出现错误码110时,一般来说出现这样的错误代码,都是网络连接上出现了问题。...服务器堡垒机错误码110的解决 很多朋友在遇到服务器堡垒机登录报错时,往往会不知所措,不知道如何来解决这类问题。...其实对于错误码110的报错,用户可以首先尝试联系云端服务供应商,看是否是远程服务器进行测试或者重启,此外也可以联系企业的宽带供应商了解是否是服务出现了问题。...此外对企业内部的网络设备进行检查确保所有设备都工作正常,是解决错误码110的主要方法。

1.6K20
领券