API响应代码标准化(最佳实践)

Question

我想为我正在开发的API创建通用响应代码。现在我知道了通常推荐使用的HTTP响应代码，但是我的API将处理多个USSD网关响应。

因此，API中的响应代码的广义映射将是非常有用的。在简短的谷歌搜索之后，我没有拿出一篇关于最佳实践的文档或文章来决定响应代码(应该是数字、字母数字、长度等等)。

任何帮助或建议都将受到高度赞赏。

Answer 1

如果HTTP代码对您来说不够好，请考虑实现自己的代码。例如，将API响应标准化如下：

{
    "status": "OK",
    "status_message": "Success",
    "meta": {
    },
    "data": {
    }
}

让'status‘作为响应代码的标识符。“status_message”--对它的文字描述。

如果方法成功执行，则返回HTTP代码200 + JSON。如果发生错误，请返回包含详细状态代码和消息的JSON的400 / 500 HTTP响应。

当然，上面的例子只是一个例子。这并不意味着它是一个现成的解决方案。

保存带有API中可能的响应代码列表的文档。在方法文档中记录每个可能的响应代码。