应用框架接口规范
精华
2023-03-12 14:25:51
9次阅读
0个评论
框架接口提供两种调用方式，REST和SDK，调用规范如下：
REST调用规范1：调用成功返回值
{
code:
0
,
data:
返回数据,
msg:
'请求成功'
}
复制
复制失败
复制成功2：调用失败返回值
{
code:
1001
,
//{错误码}
msg:
'调用失败：header中没有携带accessToken '
//{错误信息}
}
复制
复制失败
复制成功echo
"hello"
复制
复制失败
复制成功function
getAdder
(
int
$x
)
:
int
{
return
123
;
}
复制
复制失败
复制成功3：代码示例
//框架的获取数据字典接口
String
url=
Constants
.
frameWorkUrl+
"/item_type/"
+
type+
"/items"
;
//获取返回结果
String
result =
HttpRequest
.
sendGet
(
url)
;
JSONObject
json =
JSONObject
.
parseObject
(
result)
;
//返回码
int
code =
Integer
.
parseInt
(
json.
getString
(
"code"
)
)
;
//请求结果描述
String
msg =
json.
getString
(
"msg"
)
;
if
(
code==
0
)
{
//调用成功
return
new
ResponseEntity
<
>
(
result,
HttpStatus
.
OK)
;
}
else
{
//调用失败
return
new
ResponseEntity
<
>
(
""
,
HttpStatus
.
NOT_FOUND)
;
}
复制
复制失败
复制成功4：错误码类型
类型
错误码
备注
接口认证相关
1001 调用失败：header中没有携带accessToken
1002 调用失败：accessToken校验失败或失效
1003 调用失败：超过调用次数限制 认证相关错误码以1开头 资源相关 2001 调用失败：请求参数不合法（参数为空或者类型不匹配） 资源相关错误码以2开头 业务自定义错误 示例： 9001 返回值异常，没有查到此id对应的用户 业务相关错误码以9开头
1002 调用失败：accessToken校验失败或失效
1003 调用失败：超过调用次数限制 认证相关错误码以1开头 资源相关 2001 调用失败：请求参数不合法（参数为空或者类型不匹配） 资源相关错误码以2开头 业务自定义错误 示例： 9001 返回值异常，没有查到此id对应的用户 业务相关错误码以9开头
目前定义以上三类错误码，随着业务的发展会不断完善。
SDK调用规范SDK方式是通过平台提供的jar包调用，如果SDK升级，各业务模块只需要替换SDK包即可。
0
0