是否存在错误/错误代码的标准？

Question

我目前正在为国际象棋游戏编写API /一些客户端。

开发人员应该通过一个脚本（xhrframework.php）访问API并通过GET提交操作。他们提交动作时可能会出现一些错误（没有发送PHPSESSID，没有有效的PHPSESSID，移动无效，轮到他们了......）。

所以我想到了如何显示错误的可能性。我提出了一些想法，告诉程序员，他犯了一个错误：

1. 通过英文清楚的错误信息
   • +：很清楚错误应该是什么意思
   • +：可以添加如何修复此错误的信息
   • - ：由于我的英语不是很好，信息可能会改变
   • - ：消息的长度差别很大 - 这对C程序员来说可能很重要
2. 通过英语中的ab错误消息常量 - 类似于WRONG_PHPSESSID，MISSING_PHPSESSID，INVALID_MOVE，NOT_YOUR_TURN，......
   • +：这对人类来说是可以理解的
   • 0：几乎可以肯定消息没有改变
   • - ：消息的长度可能略有不同
3. 通过文档中的一个表的错误代码，程序员可以在其中找到错误代码的含义
   • +：错误代码将是常量
   • +：每个错误代码的长度可以相同
   • - ：这是神秘的

我觉得第三个解决方案可能是一个好主意，因为xhrframework.php只能由程序员访问，而程序员很可能已经看过API文档。

现在我想知道是否存在Web-API-Error消息的标准。其他人（例如Google Maps API）是如何解决这个问题的？我应该只输出一个内容为“ERROR：004”或没有填充“ERROR：4”的空白页面吗？

哪些错误应该得到哪些数字？根据数字对错误进行分组是否有意义，例如：所有以1开头的错误都是认证错误，所有错误都有两个游戏逻辑错误？从错误1开始并使用每个数字会更好吗？

Google Maps API

如果我向Google Maps JS-API发出wrong call，它会返回带有清晰德语信息的Java-Script（我想我住在德国）。

如果我制作wrong call，则Google Static Maps API会以明文英文的形式返回消息。

Answer 1

大多数API服务都遵循HTTP错误代码系统RFC2817，并为不同类型的错误提供错误代码范围：

1xx: Informational - Request received, continuing process 
2xx: Success - The action was successfully received, understood, and accepted 
3xx: Redirection - Further action must be taken in order to complete the request 
4xx: Client Error - The request contains bad syntax or cannot be fulfilled 
5xx: Server Error - The server failed to fulfil an apparently valid request

在API上下文中，您通常会使用4xx值来表示与请求验证有关的错误条件。 49x通常用于安全错误情况。

Answer 2

没有标准，为什么会这样？使用您的界面的程序员必须了解这一点，这可能是自定义的，因此需要编写自定义错误处理代码只是程序包的一部分。

我建议你制作一个你会坚持的合理格式。您可以与每个世界中最好的一起使用，并在您返回的内容中包含几条信息，或许可以按照以下方式：

[one of "ERROR" or "WARNING" or "MESSAGE"]
[error code with no spaces, eg "BAD_MOVE"]
[optional human readable string]

这样，如果发明旧的客户不理解的新错误类型，他们仍然可以认识到返回以“错误”开始并且知道出错了;通过解析错误代码（不使用整数，浪费每个人的时间），如果程序员考虑到错误，他们可以采取适当的措施。最后，如果您为选定的错误添加一个友好的字符串，它可以很容易地向用户呈现一些不错的东西或者有助于调试。