mm_ret 1.3.9 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +158 -0
- package/package.json +5 -5
package/README.md
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# mm_ret
|
|
2
|
+
|
|
3
|
+
这是一个用于输出JSON-RPC 2.0标准结果的Node.js模块。它提供了一系列便捷的方法来生成标准的JSON-RPC响应和请求。
|
|
4
|
+
|
|
5
|
+
## 安装
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install mm_ret
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## 基本使用
|
|
12
|
+
|
|
13
|
+
```javascript
|
|
14
|
+
const { Ret, Req, Error } = require('mm_ret');
|
|
15
|
+
// 或者直接使用全局变量
|
|
16
|
+
require('mm_ret');
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## 类说明
|
|
20
|
+
|
|
21
|
+
### Error 类
|
|
22
|
+
|
|
23
|
+
错误代码管理类，用于管理JSON-RPC标准错误码和自定义错误码。
|
|
24
|
+
|
|
25
|
+
#### 方法
|
|
26
|
+
|
|
27
|
+
##### get(keyword)
|
|
28
|
+
- 说明：根据关键词或错误码获取对应的错误信息
|
|
29
|
+
- 参数：
|
|
30
|
+
- keyword: {String|Number} 关键词或错误码
|
|
31
|
+
- 返回值：{Object} 错误信息对象，包含code和message
|
|
32
|
+
|
|
33
|
+
### Ret 类
|
|
34
|
+
|
|
35
|
+
响应结果生成类，用于生成标准的JSON-RPC 2.0响应结果。
|
|
36
|
+
|
|
37
|
+
#### 方法
|
|
38
|
+
|
|
39
|
+
##### body(result, error, id)
|
|
40
|
+
- 说明：生成基础的JSON-RPC响应体
|
|
41
|
+
- 参数：
|
|
42
|
+
- result: {Object} 返回的结果
|
|
43
|
+
- error: {Object} 返回的错误信息
|
|
44
|
+
- id: {String} 消息ID
|
|
45
|
+
- 返回值：{Object} 标准的JSON-RPC响应对象
|
|
46
|
+
|
|
47
|
+
##### error(code, message, id)
|
|
48
|
+
- 说明：生成错误响应
|
|
49
|
+
- 参数：
|
|
50
|
+
- code: {Number} 错误码
|
|
51
|
+
- message: {String} 错误信息
|
|
52
|
+
- id: {String} 消息ID
|
|
53
|
+
- 返回值：{Object} 包含错误信息的JSON-RPC响应对象
|
|
54
|
+
|
|
55
|
+
##### list(list, count, id)
|
|
56
|
+
- 说明：生成列表类型的响应
|
|
57
|
+
- 参数：
|
|
58
|
+
- list: {Array} 数据列表
|
|
59
|
+
- count: {Number} 总数量
|
|
60
|
+
- id: {String} 消息ID
|
|
61
|
+
- 返回值：{Object} 包含列表数据的JSON-RPC响应对象
|
|
62
|
+
|
|
63
|
+
##### obj(obj, id)
|
|
64
|
+
- 说明：生成对象类型的响应
|
|
65
|
+
- 参数：
|
|
66
|
+
- obj: {Object} 返回的对象
|
|
67
|
+
- id: {String} 消息ID
|
|
68
|
+
- 返回值：{Object} 包含对象数据的JSON-RPC响应对象
|
|
69
|
+
|
|
70
|
+
##### bl(bl, tip, id)
|
|
71
|
+
- 说明：生成布尔类型的响应
|
|
72
|
+
- 参数：
|
|
73
|
+
- bl: {Boolean} 布尔值
|
|
74
|
+
- tip: {String} 提示信息
|
|
75
|
+
- id: {String} 消息ID
|
|
76
|
+
- 返回值：{Object} 包含布尔值和提示信息的JSON-RPC响应对象
|
|
77
|
+
|
|
78
|
+
### Req 类
|
|
79
|
+
|
|
80
|
+
请求生成类，用于生成标准的JSON-RPC 2.0请求。
|
|
81
|
+
|
|
82
|
+
#### 构造函数
|
|
83
|
+
|
|
84
|
+
```javascript
|
|
85
|
+
new Req(scope)
|
|
86
|
+
```
|
|
87
|
+
- scope: {String} 作用域，默认为"sys"
|
|
88
|
+
|
|
89
|
+
#### 方法
|
|
90
|
+
|
|
91
|
+
##### send(method, params)
|
|
92
|
+
- 说明：生成JSON-RPC请求
|
|
93
|
+
- 参数：
|
|
94
|
+
- method: {String} 方法名
|
|
95
|
+
- params: {Object} 参数对象
|
|
96
|
+
- 返回值：{Object} 标准的JSON-RPC请求对象
|
|
97
|
+
|
|
98
|
+
## 使用示例
|
|
99
|
+
|
|
100
|
+
### 响应结果示例
|
|
101
|
+
|
|
102
|
+
```javascript
|
|
103
|
+
// 错误响应
|
|
104
|
+
var body = $.ret.error(10000, '错误');
|
|
105
|
+
// 输出: {"error":{"code":10000,"message":"错误"}}
|
|
106
|
+
|
|
107
|
+
// 普通结果响应
|
|
108
|
+
body = $.ret.body("这是一个结果");
|
|
109
|
+
// 输出: {"result":"这是一个结果"}
|
|
110
|
+
|
|
111
|
+
// 对象响应
|
|
112
|
+
body = $.ret.obj({ "name": "张三", age: 18});
|
|
113
|
+
// 输出: {"result":{"obj":{"name":"张三","age":18}}}
|
|
114
|
+
|
|
115
|
+
// 列表响应
|
|
116
|
+
body = $.ret.list([{ "name": "张三", age: 18}, { "name": "李四", age: 24}]);
|
|
117
|
+
// 输出: {"result":{"list":[{"name":"张三","age":18},{"name":"李四","age":24}]}}
|
|
118
|
+
|
|
119
|
+
// 布尔响应
|
|
120
|
+
body = $.ret.bl(true, "修改成功");
|
|
121
|
+
// 输出: {"result":{"bl":true,"tip":"修改成功"}}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### 请求示例
|
|
125
|
+
|
|
126
|
+
```javascript
|
|
127
|
+
// 基本请求
|
|
128
|
+
var body = $.req.send('test', "你好吗");
|
|
129
|
+
|
|
130
|
+
// 使用模板的请求
|
|
131
|
+
$.req.tpl.message = {
|
|
132
|
+
"to_user": "",
|
|
133
|
+
"from_user": "",
|
|
134
|
+
"content": ""
|
|
135
|
+
};
|
|
136
|
+
body = $.req.send('message', { content: "你好吗?", "media": { "title": "牛" } });
|
|
137
|
+
// 输出的请求会自动合并模板中的字段
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## 错误码说明
|
|
141
|
+
|
|
142
|
+
| 错误码 | 说明 |
|
|
143
|
+
|--------|------|
|
|
144
|
+
| -32700 | not well formed |
|
|
145
|
+
| -32701 | unsupported encoding |
|
|
146
|
+
| -32702 | invalid character for encoding |
|
|
147
|
+
| -32600 | invalid json-rpc. not conforming to spec |
|
|
148
|
+
| -32601 | requested method not found |
|
|
149
|
+
| -32602 | invalid method parameters |
|
|
150
|
+
| -32603 | internal json-rpc error |
|
|
151
|
+
| -32500 | application error |
|
|
152
|
+
| -32400 | system error |
|
|
153
|
+
| -32300 | transport error |
|
|
154
|
+
| 10000 | 业务逻辑脚本错误 |
|
|
155
|
+
| 30000 | 身份验证失败 |
|
|
156
|
+
| 40000 | 数据库执行错误 |
|
|
157
|
+
| 50000 | 服务端执行错误 |
|
|
158
|
+
| 70000 | 参数不正确 |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mm_ret",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.1",
|
|
4
4
|
"description": "这是超级美眉http请求结果输出类函数模块，用于输出json-rpc2.0标准结果",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
},
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
11
|
-
"url": "git+https://
|
|
11
|
+
"url": "git+https://gitee.com/qiuwenwu91/mm_ret.git"
|
|
12
12
|
},
|
|
13
13
|
"keywords": [
|
|
14
14
|
"myret",
|
|
@@ -26,10 +26,10 @@
|
|
|
26
26
|
"author": "邱文武",
|
|
27
27
|
"license": "ISC",
|
|
28
28
|
"bugs": {
|
|
29
|
-
"url": "https://
|
|
29
|
+
"url": "https://gitee.com/qiuwenwu91/mm_ret/issues"
|
|
30
30
|
},
|
|
31
|
-
"homepage": "https://
|
|
31
|
+
"homepage": "https://gitee.com/qiuwenwu91/mm_ret#readme",
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"mm_expand": "^1.
|
|
33
|
+
"mm_expand": "^1.8.3"
|
|
34
34
|
}
|
|
35
35
|
}
|