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

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消息的标准.其他人(例如谷歌地图API)如何解决这个问题？我应该只输出一个内容为"ERROR:004"或没有填充"ERROR:4"的空白页面吗？

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

Google Maps API

如果我对Google Maps JS-API 进行了错误的调用,它会返回带有清晰德语消息的Java-Script(我想我住在德国).

如果我拨打错误电话,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通常用于安全错误情况.