本文介绍了API错误返回的规范，强调禁止通过抛异常方式返回业务错误，建议使用Response的code和message字段。同时，提倡API提供方为需要错误细分处理的情况提供判断工具类，并返回可以直接显示给用户的中文提示信息，确保错误信息的可读性和引导性。
API错误返回规范
禁止通过抛异常形式返回API业务错误
API禁止抛Checked异常，即业务处理上的参数错误、逻辑错误、业务错误等禁止通过抛异常形式返回，应用Response#code, message表达业务错误。
注：不要逼调用方到处写try{}catch()。
- 正例：
Response<T> saveDesposit(...);
- 反例：
T saveDesposit(...) throws ServiceException, IllegalArgumentException, ValidationException;
禁止通过抛异常形式返回API业务错误
API禁止抛Checked异常，即业务处理上的参数错误、逻辑错误、业务错误等禁止通过抛异常形式返回，应用Response#code, message表达业务错误。
注：不要逼调用方到处写try{}catch()。
- 正例：
Response<T> saveDesposit(...);
- 反例：
T saveDesposit(...) throws ServiceException, IllegalArgumentException, ValidationException;
需要调用方做错误细分处理的，API提供方务必一并提供判断工具类
- 正例：
最低0.47元/天 解锁文章
1922
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
