外观
service error
为了统一错误信息,所有插件返回错误的时候都按照以下格式
属性 | 类型 | 说明 |
---|---|---|
type | string | 错误类型,可设置为下方错误之一 |
message | string | 错误描述,用于展示给用户看 |
addition | any | 附加信息,可以是任何可 json 序列化的数据类型,用于 debug |
troubleshootingLink | string | 故障排除的链接,目前主要用在插件验证的功能 Bob 1.6.0+ 可用 |
错误类型(type
)如下:
unknown
未知错误param
参数错误unsupportedLanguage
不支持的语言secretKey
未设置秘钥network
请求服务器异常(网络连接失败、服务器返回 HTTP 状态码异常等)api
服务异常(接口返回数据异常等)notFound
服务调用过程未出错,但是未查询到结果;例如词典不包含某个词汇
请尽量将错误类型(type
)设置正确,如果实在不知道错误类型归为哪一类,type
可设置为 unknown
,但一定要设置好 message
,用于提示
针对文本翻译类型的插件,如果翻译出错返回错误类型为 unsupportedLanguage
或 notFound
,Bob 会自动将该插件对应的翻译视图折叠起来。