Web API中的符号与数字错误代码

时间:2012-08-02 10:42:50

标签: php api exception error-code

我目前正在开发新项目,该项目应该提供基于Web的API。当然,在许多情况下,当请求操作失败时,API应报告此失败的原因。

以前我使用传统方式,当响应包含数字错误代码和更人性化的错误消息时,但维护错误代码列表和我的代码与内部异常之间的映射有点令人沮丧。

我认为使用符号错误代码可能更方便,例如从异常名称生成。

我看到了这个想法的以下优点:

  • 无需从例外映射到数字。
  • 无法将相同的错误代码分配给不同的错误类型(在我的情况下 - 例外情况)。
  • 对于将自行使用API​​的开发人员而言,错误代码会提供更多信息。

缺点:

  • 在封装方面,公开异常名称可能不是一个好主意。
  • 由于API客户端应用程序主要使用错误代码来确定错误类型,因此比较字符串会更加昂贵。
  • 无需中央例外 - >错误代码注册表增加了错过文档中某些错误代码的机会。

那么,最好使用什么:符号或数字错误代码?

0 个答案:

没有答案