Skip to content

Commit 08fbdb8

Browse files
committed
Document:修正 Roadmap 的文档错误,优化格式
1 parent 23c8406 commit 08fbdb8

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

Roadmap.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66

77
### 完善功能
8-
部分功能描述可在 [APIAuto](https://github.com/TommyLemon/APIAuto) 上查看
9-
账号 13000002020 密码 123456
10-
http://apijson.org:8000/auto/
8+
部分功能描述可在 [APIAuto](https://github.com/TommyLemon/APIAuto) 上查看 <br />
9+
账号 13000002020 密码 123456 <br />
10+
http://apijson.org:8000/auto/ <br />
1111

1212
#### 新增支持 Case
1313

@@ -58,7 +58,7 @@ http://apijson.org:8000/auto/
5858
#### 新增支持 Union
5959

6060
虽然可以通过 INNER JOIN + 条件 OR 连接来替代它的功能,但没法达到它能用索引的性能。<br />
61-
支持 UNION 很有必要,但 UNION ALL 几乎没有需求,如果实现简单、且不影响原来的功能,则可以顺便加上。
61+
支持 UNION 很有必要,但 UNION ALL 几乎没有需求,如果实现简单、且不影响原来的功能,则可以顺便加上。 <br />
6262

6363
"@union": Integer // 0 - 不使用,1 - UNION,2 - UNION ALL
6464
```js
@@ -135,10 +135,12 @@ WITH (SELECT `id` FROM `sys`.`User` WHERE `id` IN($contactIdList)) AS `sql`
135135
SELECT * FROM `sys`.`Comment` WHERE ( (`userId` IN `sql` ) ) ORDER BY `date` DESC LIMIT 10 OFFSET 0
136136
```
137137

138+
#### ... //欢迎补充
139+
138140

139141

140142
### 保障安全
141-
APIJSON 提供了各种安全机制,可在目前的新增或改进
143+
APIJSON 提供了各种安全机制,可在目前的基础上新增或改进
142144

143145

144146
#### 防越权操作
@@ -158,6 +160,8 @@ APIJSONFramework 则使用 [Access 表](https://github.com/APIJSON/APIJSON/blob/
158160
目前有限流机制,getMaxQueryCount, getMaxUpdateCount, getMaxObjectCount, getMaxSQLCount, getMaxQueryDepth 等。 <br />
159161
https://github.com/APIJSON/APIJSON/blob/master/APIJSON-Java-Server/APIJSONORM/src/main/java/apijson/orm/Parser.java
160162

163+
#### ... //欢迎补充
164+
161165

162166
### 优化性能
163167

@@ -171,12 +175,12 @@ https://github.com/APIJSON/APIJSON/blob/master/APIJSON-Java-Server/APIJSONORM/sr
171175

172176
#### 拼接 SQL
173177

174-
优化 [AbstractSQLExecutor](https://github.com/APIJSON/APIJSON/blob/master/APIJSON-Java-Server/APIJSONORM/src/main/java/apijson/orm/AbstractSQLConfig.java) 拼接 SQL 性能。<br />
175-
[完善功能](https://github.com/APIJSON/APIJSON/blob/master/Roadmap.md#%E5%AE%8C%E5%96%84%E5%8A%9F%E8%83%BD) 中 Union 和 With 也是优化 SQL 性能的方式。
178+
优化 [AbstractSQLConfig](https://github.com/APIJSON/APIJSON/blob/master/APIJSON-Java-Server/APIJSONORM/src/main/java/apijson/orm/AbstractSQLConfig.java) 拼接 SQL 性能。<br />
179+
[完善功能](https://github.com/APIJSON/APIJSON/blob/master/Roadmap.md#%E5%AE%8C%E5%96%84%E5%8A%9F%E8%83%BD) 中 Union 和 With 也是优化 SQL 性能的方式。 <br />
176180

177181
#### 读写缓存
178182

179-
[AbstractSQLExecutor](https://github.com/APIJSON/APIJSON/blob/master/APIJSON-Java-Server/APIJSONORM/src/main/java/apijson/orm/AbstractParser.java) 使用了 HashMap<String, JSONObject> queryResultMap 存已解析的对象、总数等数据。<br />
183+
[AbstractParser](https://github.com/APIJSON/APIJSON/blob/master/APIJSON-Java-Server/APIJSONORM/src/main/java/apijson/orm/AbstractParser.java) 使用了 HashMap<String, JSONObject> queryResultMap 存已解析的对象、总数等数据。<br />
180184
[AbstractSQLExecutor](https://github.com/APIJSON/APIJSON/blob/master/APIJSON-Java-Server/APIJSONORM/src/main/java/apijson/orm/AbstractSQLExecutor.java) 使用了 HashMap<String, JSONObject> cacheMap 存已通过 SQL 查出的结果集。<br />
181185

182186
#### ... //欢迎补充
@@ -186,44 +190,44 @@ https://github.com/APIJSON/APIJSON/blob/master/APIJSON-Java-Server/APIJSONORM/sr
186190
### 增强稳定
187191
APIJSON 代码经过商业分析软件 [源伞Pinpoint](https://www.sourcebrella.com/) 的质检,报告说明 APIJSON 非常可靠。<br />
188192
https://github.com/APIJSON/APIJSON/issues/48 <br />
189-
但我们需要再接再厉,尽可能做到 99.999% 可靠度,降低使用风险,让用户放心和安心。
193+
但我们需要再接再厉,尽可能做到 99.999% 可靠度,降低使用风险,让用户放心和安心。 <br />
190194

191195
#### 减少 Bug
192196

193-
##### 1.[APIAuto](https://github.com/TommyLemon/APIAuto) 上统计的 bug
197+
##### [APIAuto](https://github.com/TommyLemon/APIAuto) 上统计的 bug
194198
账号 13000002000 密码 123456
195199
http://apijson.org:8000/auto/
196200

197-
##### 2.其它发现的 Bug
201+
##### 其它发现的 Bug
198202
https://github.com/APIJSON/APIJSON/issues?q=is%3Aissue+is%3Aopen+label%3Abug
199203

200204
#### 完善测试
201205

202-
1.在 [APIAuto](https://github.com/TommyLemon/APIAuto)-机器学习自动化接口管理平台 上传更多、更全面、更细致的测试用例、动态参数等
206+
##### APIAuto-机器学习自动化接口管理平台 上传更多、更全面、更细致的测试用例、动态参数等
203207
http://apijson.org:8000/auto/
204208

205-
2.接入 UnitAuto-机器学习自动化单元测试平台,每次启动都自动测试所有可测方法并输出报告
209+
##### 接入 UnitAuto-机器学习自动化单元测试平台,每次启动都自动测试所有可测方法并输出报告
206210
https://gitee.com/TommyLemon/UnitAuto
207211

208212

209213
### 完善文档
210214
#### 中文文档
211215

212-
##### 1.通用文档
216+
##### 通用文档
213217
https://github.com/APIJSON/APIJSON/blob/master/Document.md
214218

215-
##### 2.配置与部署
219+
##### 配置与部署
216220
https://github.com/APIJSON/APIJSON/tree/master/APIJSON-Java-Server
217221

218222
##### ... //欢迎补充
219223

220224

221225
#### English Document
222226

223-
Translation for Chinese document.
224-
https://github.com/APIJSON/APIJSON/blob/master/README-English.md
225-
https://github.com/APIJSON/APIJSON/blob/master/Document-English.md
226-
https://github.com/ruoranw/APIJSONdocs
227+
Translation for Chinese document. <br />
228+
https://github.com/APIJSON/APIJSON/blob/master/README-English.md <br />
229+
https://github.com/APIJSON/APIJSON/blob/master/Document-English.md <br />
230+
https://github.com/ruoranw/APIJSONdocs <br />
227231

228232

229233

@@ -253,7 +257,7 @@ https://github.com/APIJSON/APIJSON
253257
目前可使用 "format": true 让后端格式化后返回,但也会对服务器性能有一些损耗,<br />
254258
如果 前端/客户端 有对应的格式化工具等(例如 APIJSONORM 可供 Android 使用 format),选择就会更多一些。<br />
255259

256-
260+
##### ... //欢迎补充
257261

258262
### 推广使用
259263
#### 为 APIJSON 编写/发表 博客/文章/资讯 等

0 commit comments

Comments
 (0)