Skip to content

honest_dong / accountDocs

Go to a project
Commit 21435790 by dongzhengcheng
Options

调整返回数据状态码和数据格式

parent 4ca3f7d4
Showing with 25 additions and 34 deletions
docs/apis/account/accountBank.md
...@@ -37,7 +37,7 @@ ...@@ -37,7 +37,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/account/accountDestory.md
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{} {}
......
docs/apis/account/accountInfo.md
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/account/accountInterest.md
...@@ -34,7 +34,7 @@ ...@@ -34,7 +34,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/account/accountLocking.md
...@@ -35,7 +35,7 @@ ...@@ -35,7 +35,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/account/accountLockingList.md
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/account/accountLog.md
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/account/accountOpen.md
...@@ -41,7 +41,7 @@ ...@@ -41,7 +41,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/account/accountUnlocking.md
...@@ -34,7 +34,7 @@ ...@@ -34,7 +34,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/account/accountUpdate.md
...@@ -47,7 +47,7 @@ ...@@ -47,7 +47,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/index.md
...@@ -36,57 +36,47 @@ app_secret|123456789|对应接口秘钥 ...@@ -36,57 +36,47 @@ app_secret|123456789|对应接口秘钥
stateCode | 含义 |返回内容| stateCode | 含义 |返回内容|
-----|--------|--- -----|--------|---
200 |数据请正常返回 | 正常数据，见各接口格式 200 |数据请正常返回 | status = ‘SUCCESS’ 正常数据，见各接口格式， status = ‘WARNING’，有警告数据。
301 |业务错误| <a href="#error_301">错误代码</a>
401 |未授权| <a href="#error_401">错误代码</a> 401 |未授权| <a href="#error_401">错误代码</a>
404 |方法不存在| <a href="#error_404">错误代码</a> 404 |方法不存在| <a href="#error_404">错误代码</a>
409 |冲突请求|错误代码 409 |冲突请求|错误代码
421 |会话超时| <a href="#error_421">错误代码</a> 421 |会话超时| <a href="#error_421">错误代码</a>
422 |表验证错误|<a href="#error_422">错误代码</a> 422 |表验证错误|<a href="#error_422">错误代码</a>
500 |服务器错误，确认状态并报告问题|<a href="#error_500">错误代码</a> 430 |操作失败：可以根据对应的 error_code 做对应的业务操作| <a href="#error_430">错误代码</a>
500 |服务器脚本错误|<a href="#error_500">错误代码</a>
<a name="error_301" ></a>
301:
{
"message":"错误内容",
"status_code":301
}
<a name="error_500" ></a> <a name="error_500" ></a>
500:
{ {
"message":"Undefined variable:users", "message":"Undefined variable:users",
"status_code":500
} }
<a name="error_430" ></a>
{
"status": "FAILS",
"message": "操作失败",
"error_code": 10430,
"errors": []
}
<a name="error_401" ></a> <a name="error_401" ></a>
401：
{ {
"message":"Failed to authenticate because of bad credentials or an invalid authorization header.", "message":"Failed to authenticate because of bad credentials or an invalid authorization header.",
"status_code":401
} }
<a name="error_403" ></a> <a name="error_403" ></a>
403：
{ {
"message":"Failed to authenticate because of bad credentials or an invalid authorization header.", "message":"Failed to authenticate because of bad credentials or an invalid authorization header.",
"status_code":403
} }
<a name="error_422" ></a> <a name="error_422" ></a>
422
{ {
"message": "Could not create new user.", "message": "Could not create new user.",
"status_code": 422,
"errors": { "errors": {
"username": [ "username": [
"The username field is required." "The username field is required."
......
docs/apis/trades/tradesCheckCode.md
...@@ -28,7 +28,7 @@ ...@@ -28,7 +28,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/trades/tradesPay.md
...@@ -37,6 +37,7 @@ ...@@ -37,6 +37,7 @@
|business_id |是|string（10） |业务交易ID| |business_id |是|string（10） |业务交易ID|
|business_type |是|string（10） |业务交易类型| |business_type |是|string（10） |业务交易类型|
|account_no |是|string(60) |出金账户 | |account_no |是|string(60) |出金账户 |
|trade_type |是|int |交易类型 |
|amount |是|int |出金金额 | |amount |是|int |出金金额 |
|bank_no |否|string |入金行号| |bank_no |否|string |入金行号|
|bank_Name |否|string |入金行名| |bank_Name |否|string |入金行名|
...@@ -49,7 +50,7 @@ ...@@ -49,7 +50,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
docs/apis/trades/tradesRefund.md
...@@ -33,7 +33,7 @@ ...@@ -33,7 +33,7 @@
``` ```
{ {
'status_code':'200', 'status':'SUCCESS',
'message':'操作成功', 'message':'操作成功',
'data': 'data':
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment