为 API 定义自定义错误代码的最佳做法

Best practices to define custom error codes for an API

我们正计划开发 API。在很多情况下，一个请求都可以被认为是一个错误的请求。 为此，我们计划发送一个带有 error code、error 的 JSON 对象， 和 additional info

用户发送照明图像时的示例我已经放在这里了。我们认为此请求是错误请求并发送以下 JSON

{
"ErrorCode": 10000,
"Error": "Detected uneven illumination image",
"Additional Info": "Prefer to change the image location"
}
  1. 我们的 JSON 对象格式是否正确，或者我们需要添加 HTTP 错误代码，如 400/404
  2. 如何select这个自定义错误代码？我们计划从 10000 中取出错误代码编号。

有人可以帮助我们或提供一些值得信赖的资源吗？

检查 Stripe API they also use error codes (code) 以解释不同的 4xx 错误