Skip to content

Commit d77d77b

Browse files
authored
Update 详细的说明文档.md
1 parent a92d5c1 commit d77d77b

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

详细的说明文档.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs
9797
修改步骤:
9898

9999
- 请修改 Eclipse 中的 Maven 镜像地址,以便更快下载或者更新,具体方法自行百度;
100-
- 打开 Eclipse->Windows->Preferences->Maven->Installations->add 这个按钮用于指定 maven 的安装目录。这里不建议使用 eclipse 自带的,需要再自己设置。最终效果如下图所示:
100+
- 打开 Eclipse->Windows->Preferences->Maven->Installations->Add 这个按钮用于指定 Maven 的安装目录。这里不建议使用 Eclipse 自带的,需要再自己设置。最终效果如下图所示:
101101
![install3](https://raw.githubusercontent.com/APIJSON/APIJSON-Doc/master/docs/.vuepress/public/assets/install3.png)
102102
- 打开 Eclipse->Windows->Preferences->Maven->User Settings 这是指定 setting.xml 的位置,同时导向自己的本地 maven 仓库。最终效果如下图所示:
103103
![install4](https://raw.githubusercontent.com/APIJSON/APIJSON-Doc/master/docs/.vuepress/public/assets/install4.png)
@@ -120,7 +120,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs
120120
| 密码 | apijson |
121121
| 数据库 | sys |
122122

123-
那么需要在`DemoSQLConfig`,40-61行,改为自己数据库对应的链接
123+
那么需要在 `DemoSQLConfig` 配置数据库
124124

125125
```java
126126
static {
@@ -158,7 +158,7 @@ https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSOND
158158

159159
#### C-1-2.导入表
160160

161-
[APIJSON-Demo-Master/MySQL](https://github.com/APIJSON/APIJSON-Demo/tree/master/MySQL) 目录下有一批SQL脚本,他们看起来是这样的
161+
[APIJSON-Demo-Master/MySQL](https://github.com/APIJSON/APIJSON-Demo/tree/master/MySQL) 目录下有一批 SQL 脚本,他们看起来是这样的
162162

163163
![1542345654422](assets/1542345654422.png)
164164

@@ -182,15 +182,15 @@ https://github.com/TommyLemon/APIAuto
182182

183183
#### C-1-3.测试查询
184184

185-
为了方便测试,我这里使用的Chrome浏览器的Restlet Client插件,大家可以根据自己的喜好使用不同的工具测试。
185+
为了方便测试,我这里使用的 Chrome 浏览器的 Restlet Client 插件,大家可以根据自己的喜好使用不同的工具测试。
186186

187-
使用` http://localhost:8080/get`测试结果。(请注意 DemoApplication.java 中使用 Tomcat 默认的 8080 端口,如果不小心开着PC端的“微信”,8080端口会被占用,建议改成 8081, 9090 等其它应用程序未占用的端口。)
187+
使用 `http://localhost:8080/get` 测试结果。(请注意 DemoApplication.java 中使用 Tomcat 默认的 8080 端口,如果不小心开着PC端的“微信”,8080 端口会被占用,建议改成 8081, 9090 等其它应用程序未占用的端口。)
188188

189-
随便找一个表,比如`Moment`表,我们取其中ID为12的一条出来看看
189+
随便找一个表,比如 `Moment` 表,我们取其中 id 为 12 的一条出来看看
190190

191191
![1542350018926](assets/1542350018926.png)
192192

193-
对接口地址`http://localhost:8080/get`发送一个JSON格式的请求
193+
对接口地址 `http://localhost:8080/get` 发送一个 JSON 格式的请求
194194

195195
![1542350219020](assets/1542350219020.png)
196196

@@ -232,7 +232,7 @@ https://github.com/TommyLemon/APIAuto
232232

233233
##### 字段过滤
234234

235-
这里这么多字段,如果我只想要这个`content`字段的信息怎么办?
235+
这里这么多字段,如果我只想要这个 `content` 字段的信息怎么办?
236236

237237
你可以这样请求:
238238

@@ -257,7 +257,7 @@ https://github.com/TommyLemon/APIAuto
257257
}
258258
```
259259

260-
`@column`表示你要筛选出的字段,如果是多个字段可以这样写`"@column":"id,date,content"`
260+
`@column` 表示你要筛选出的字段,如果是多个字段可以这样写 `"@column":"id,date,content"`
261261

262262

263263

@@ -275,13 +275,13 @@ https://github.com/TommyLemon/APIAuto
275275
}
276276
```
277277

278-
这样在返回的数据中`date`字段就变成了`time``content`字段变成了`text`
278+
这样在返回的数据中 `date` 字段就变成了 `time`, `content` 字段变成了 `text`
279279

280280

281281

282282
##### 逻辑运算
283283

284-
如果想要筛选出,ID在`12,15,32`中的这三条数据的`日期``内容`怎么办呢?
284+
如果想要筛选出,id 在 `12,15,32` 中的这三条数据的`日期``内容`怎么办呢?
285285

286286
请求:
287287

@@ -329,25 +329,25 @@ https://github.com/TommyLemon/APIAuto
329329

330330

331331

332-
如果所要筛选的数据的是在一定范围内的,比如ID是300到400之间的
332+
如果所要筛选的数据的是在一定范围内的,比如 id 是 300 到 400 之间的
333333

334-
你可以这样过滤`"id&{}":">=300,<=400"`
334+
你可以这样过滤 `"id&{}":">=300,<=400"`
335335

336336
&的作用是表明后面的两个过滤条件的逻辑关系
337337

338338
```sql
339-
(ID >= 300 AND ID <= 500)
339+
(id >= 300 AND id <= 500)
340340
```
341341

342342

343343

344344
现在的逻辑符号一共有三种,`&``|``!`
345345

346-
默认的逻辑关系是`|`,也就是说`"id|{}":"<=300,>=400"``"id{}":"<=300,>=400"`等价。
346+
默认的逻辑关系是 `|`,也就是说 `"id|{}":"<=300,>=400"``"id{}":"<=300,>=400"` 等价。
347347

348348
`!`主要用于反选,黑名单之类的
349349

350-
`"id!{}":[12,15,32]`表示`id`不在12,15,32内的其他数据
350+
`"id!{}":[12,15,32]` 表示 `id` 不在 12,15,32 内的其他数据
351351

352352
复杂一些,如果多个条件相互组合,可以写多个关于id的过滤条件
353353

@@ -363,7 +363,7 @@ https://github.com/TommyLemon/APIAuto
363363
}
364364
```
365365

366-
比如这里表示id在10到40之间,但是却不包含12的数据
366+
比如这里表示 id 在 10 到 40 之间,但是却不包含 12 的数据
367367

368368

369369

@@ -382,15 +382,15 @@ https://github.com/TommyLemon/APIAuto
382382

383383
使用方式有多种:
384384

385-
`keyword%`,以`keyword`开头的字符串。
385+
`keyword%`,以 `keyword` 开头的字符串。
386386

387-
`%keyword`,以`keyword`结束的字符串。
387+
`%keyword`,以 `keyword` 结束的字符串。
388388

389-
`%keyword%`,包含`keyword`的字符串,如:`keyword123``123keyword``123keyword123`
389+
`%keyword%`,包含 `keyword` 的字符串,如:`keyword123`, `123keyword`, `123keyword123`
390390

391-
`%k%e%y%`,包含字母`k`,`e`,`y`的字符串
391+
`%k%e%y%`,包含字母 `k`, `e`, `y` 的字符串
392392

393-
还有几种比较便捷的方式,我们这里如果使用`"content~":"keyword"`来代替`"content$":"%keyword%"`,同样可以表示包含某字符串
393+
还有几种比较便捷的方式,我们这里如果使用 `"content~":"keyword"` 来代替 `"content$":"%keyword%"`,同样可以表示包含某字符串
394394

395395

396396

@@ -407,7 +407,7 @@ https://github.com/TommyLemon/APIAuto
407407
}
408408
```
409409

410-
正则表达式`^[0-9]+$`,查询`content`为纯数字的数据,[MySQL的正则语法](http://www.runoob.com/mysql/mysql-regexp.html) 如下:
410+
正则表达式 `^[0-9]+$`,查询 `content` 为纯数字的数据,[MySQL 的正则语法](http://www.runoob.com/mysql/mysql-regexp.html) 如下:
411411

412412
| 模式 | 描述 |
413413
| ---------- | ------------------------------------------------------------ |
@@ -458,7 +458,7 @@ https://github.com/TommyLemon/APIAuto
458458

459459
![1542357265371](assets/1542357265371.png)
460460

461-
如果我们想过滤出里面有`82001`的数据,我们应该这样请求
461+
如果我们想过滤出里面有 `82001` 的数据,我们应该这样请求
462462

463463
```json
464464
{
@@ -617,7 +617,7 @@ SELECT `id`,`date`,`content`,`praiseUserIdList` FROM `sys`.`Moment` LIMIT 5 OFFS
617617

618618
在讲解关联查询的时候,我们需要先了解下表之间的关系
619619

620-
现在有两张表 UserMoment,两张表的关系是下面这样
620+
现在有两张表 MomentUser,两张表的关系是下面这样
621621

622622
![1545468294295](assets/1545468294295.png)
623623

@@ -633,7 +633,7 @@ MOMENT表示动态,类似微信朋友圈、QQ 空间的动态,每一条动
633633
"id":12 // 注意 id 是主键,这个数组最多返回 1 条子项(如果 id=12 的表记录存在)
634634
},
635635
"User":{
636-
"id@":"/Moment/userId",
636+
"id@":"/Moment/userId", // 不要求物理外键,只要能关联即可
637637
"@column":"id,name"
638638
}
639639
}
@@ -714,7 +714,7 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
714714

715715
如果是有分组条件的,那我们需要使用 `@group`
716716

717-
比如,像下面 Sales 表,这张表表示,2018年1月1日某公司门下的 3 个店铺(store_id)的营业额(amt)数据
717+
比如,像下面 Sale 表,这张表表示,2018年1月1日某公司门下的 3 个店铺(store_id)的营业额(amt)数据
718718

719719
| id | store_id | amt |
720720
| ---- | -------- | ---- |
@@ -724,7 +724,7 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
724724
| 4 | 2 | 100 |
725725
| 5 | 3 | 210 |
726726

727-
如果,我们想要计算出这天每个店铺一共卖了多少,我们通过APIJSON可以这样查询
727+
如果,我们想要计算出这天每个店铺一共卖了多少,我们通过 APIJSON 可以这样查询
728728

729729
```
730730
{
@@ -889,9 +889,9 @@ APIJSON 3.7.0  版开始,依赖了 apijson-framework.jar 的不需要写任
889889

890890
~~如果低于 3.7.0 或者未依赖 apijson-framework.jar,而是直接依赖 apijson-orm.jar,则需要编写代码:~~
891891

892-
##### ~~2.1)在Model中添加对象并配置权限~~
892+
##### ~~2.1)在 Model 中添加对象并配置权限~~
893893

894-
~~项目的model目录下,新增一个类~~
894+
~~项目的 model 目录下,新增一个类~~
895895

896896
```java
897897
package apijson.demo.server.model;
@@ -909,7 +909,7 @@ public class Stone {
909909

910910
~~由于我们的类名和数据库表名不一致,需要注册一下。如果一样就不需要了。~~
911911

912-
~~设置数据库的实际表名`DemoSQLConfig`38行~~
912+
~~设置数据库的实际表名 `DemoSQLConfig`38 行~~
913913

914914
```java
915915
//表名映射,隐藏真实表名,对安全要求很高的表可以这么做
@@ -924,7 +924,7 @@ public class Stone {
924924

925925
~~注册权限是必须的,这样程序才能使用你配置的类权限去管理你的接口~~
926926

927-
~~脚本`DemoVerifier.java`的48行~~
927+
~~脚本 `DemoVerifier.java` 的 48 行~~
928928

929929
```java
930930
static { //注册权限

0 commit comments

Comments
 (0)