文章内容

2021/10/19 14:04:18,作 者: 黄兵

Python Web API 错误消息示例

最近使用 Python Flask 框架编写 API 端点,如果错误发生了,如何向调用 API 的人显示错误消息是一件非常有必要的事情。

除了 HTTP 规范中的 1 - 5 开头的状态码,我们还需要向客户显示详细的错误消息,以利于排查错误。

下面是通过 Flask API 端点向客户发出错误消息的示例:

response = {
"code": 2014,
"message": '当前 Crawler_Info 存在爬虫 IP,请先删除此爬虫 IP',
"info": "https://pdf-lib.org/"
}
return jsonify(response), 500

上面是一个示例,定义错误代码,调用者可以根据错误代码去查找详细文档,了解更多详细信息,之后显示出一段简短描述。

前端使用的是 Angular,框架使用的是 Angular Material,显示错误消息的方式如下:

首先实例化 MatSnackBar:

constructor(private snackBar: MatSnackBar) {
    
}

之后具体显示错误消息代码:

this.snackBar.open(error.error.message, '关 闭', {
                    horizontalPosition: 'start',
                    verticalPosition: 'bottom',
                });

使用的是 MatSnackBar,具体可以参考这里:MatSnackBar

上面只是一个示例,可以根据自己实际情况来定义。


黄兵个人博客原创。

转载请注明出处:黄兵个人博客 - Python Web API 错误消息示例

分享到:

发表评论

评论列表