java - 为 API 定义自定义错误代码的最佳实践

标签 java python api rest software-design

<分区>

我们正计划开发一个 API。在很多情况下,一个请求都可以被认为是一个错误的请求。 为此,我们计划发送一个带有error codeerror的JSON对象, 和附加信息

当用户发送照明图像时,我将示例案例放在这里。我们认为此请求是错误请求并发送以下 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错误

关于java - 为 API 定义自定义错误代码的最佳实践,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/64204553/

相关文章:

java - Spring Security 缓存我的身份验证

Python Xgboost GridSearchCV 被杀死,如何修复?

python - 如何使用tensorflow对象检测API提高对象检测的精度?

java - 如何创建 firebase 用户帐户

java - 为什么我在 Java 中收到 "missing return statement"错误,即使我在第二类中有 return 语句和线程主错误中的异常?

java - 如何将非 gradle JUnit 项目(使用 Hibernate 和 EntityManager)转换为 gradle Junit 项目并保持工作

python - SQLAlchemy ORM 重构器的替代品

python - 找到点和线段(不是线)之间的最短距离

c - 使用 C 访问 Twitter Streaming API

java - 使用 cookie 和内容类型 Text/plain 的放心发布请求