为 API 定义自定义错误代码的最佳实践 [关闭]

Question

关闭。 这个问题是基于意见的。 它目前不接受答案。

---

想改善这个问题吗？ 更新问题，以便通过编辑这篇文章用事实和引文来回答问题。

11 个月前关闭。

改进这个问题

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

当用户发送照明图像时，我将示例案例放在这里。 我们认为这个请求是错误的请求并发送以下 JSON

{
"ErrorCode": 10000,
"Error": "Detected uneven illumination image",
"Additional Info": "Prefer to change the image location"
}

1. 是我们的 JSON 对象格式好还是我们需要添加像 400/404 这样的 HTTP 错误代码
2. 如何选择这个自定义错误代码？ 我们计划从 10000 中获取错误代码编号。

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

Answer 1

检查Stripe API他们还使用错误代码（ code ）来解释不同的4xx错误