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

编程问答 2022-06-10

问题描述

我们正计划开发API。在很多情况下，一个请求可以被认为是一个坏请求。 为此，我们计划发送一个error code，error， 和additional info

当用户发送照明图像时，我将样品盒放在这里。我们认为此请求为错误请求，并发送以下JSON 

{
"ErrorCode": 10000,"Error": "Detected uneven illumination image","Additional Info": "Prefer to change the image location"
}
  1. 我们的JSON对象格式是好的还是我们需要添加HTTP错误代码（例如400/404）
  2. 如何选择此自定义错误代码？我们计划从10000开始使用错误代码。

有人可以帮助我们还是提供一些可信赖的资源？

解决方法

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

apiapijavajavapythonrestsoftware-design