类 ApiResult<T>
java.lang.Object
com.infilake.openapi.bidding.model.base.ApiResult<T>
- 类型参数:
T- 响应数据的类型
API 响应结果包装类
所有启曜采购 OpenAPI 的响应都遵循统一的格式规范,本类用于封装这种标准响应。
响应格式:
{
"code": 200,
"message": "success",
"data": { ... }
}
状态码说明:
- 200 - 成功
- 400 - 请求参数错误
- 401 - 认证失败
- 403 - 权限不足
- 404 - 资源不存在
- 500 - 服务器内部错误
使用示例:
ApiResult<Category> result = client.createCategory(category);
if (result.isSuccess()) {
Category created = result.getData();
System.out.println("创建成功: " + created.getCategoryName());
} else {
System.err.println("创建失败: " + result.getMessage());
}
- 从以下版本开始:
- 3.0.0
-
构造器详细资料
-
ApiResult
public ApiResult()默认构造函数 -
ApiResult
完整构造函数- 参数:
code- 响应状态码message- 响应消息data- 响应数据
-
-
方法详细资料
-
isSuccess
public boolean isSuccess()检查API调用是否成功- 返回:
- 如果状态码为200返回true,否则返回false
-
getCode
public int getCode()Get the response code- 返回:
- Response code
-
setCode
public void setCode(int code) Set the response code- 参数:
code- Response code
-
getMessage
Get the response message- 返回:
- Response message
-
setMessage
Set the response message- 参数:
message- Response message
-
getData
Get the response data- 返回:
- Response data payload
-
setData
Set the response data- 参数:
data- Response data payload
-
toString
-