Skip to content

Commit 5589779

Browse files
TommyLemonTommyLemon
authored
Update 详细的说明文档.md
1 parent a91e7b6 commit 5589779

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

‎详细的说明文档.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -710,13 +710,13 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
710710
}
711711
```
712712

713-
这里`maxid`是我们取的别名
713+
这里 `maxid` 是我们取的别名
714714

715-
如果是有分组条件的，那我们需要使用`@group`
715+
如果是有分组条件的，那我们需要使用 `@group`
716716

717-
比如，像下面SALE表，这张表表示，2018年1月1日某公司门下的3个店铺（STORE_ID）的营业额（AMT）数据
717+
比如，像下面 Sales 表，这张表表示，2018年1月1日某公司门下的 3 个店铺（store_id）的营业额（amt）数据
718718

719-
| ID | STORE_ID | AMT |
719+
| id | store_id | amt |
720720
| ---- | -------- | ---- |
721721
| 1 | 1 | 100 |
722722
| 2 | 1 | 80 |
@@ -730,7 +730,7 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
730730
{
731731
"[]": {
732732
"Sale":{
733-
"@column":"store_id;sum(amt):totAmt",
733+
"@column":"store_id;sum(amt):totAmt", // 注意 SQL 函数要用分号 ; 隔开
734734
"@group":"store_id"
735735
}
736736
}
@@ -741,7 +741,7 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
741741

742742
如果没有登录，由于权限的限制，是需要登录的。
743743

744-
登录地址`http://127.0.0.1:8080/login`，发送请求
744+
登录地址`http://localhost:8080/login`，发送请求
745745

746746
```json
747747
{
@@ -750,7 +750,7 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
750750
}
751751
```
752752

753-
账号和密码，可以到`apijson_user`里面查询
753+
账号和密码，可以到 `apijson_privacy` 里面查询
754754

755755
#### C-1-5.测试新增
756756

@@ -770,7 +770,7 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
770770
}
771771
```
772772

773-
`tag`是我们在`request`表里面配置的`tag`字段。
773+
`tag` 是我们在 `Request` 表里面配置的 `tag` 字段。
774774

775775
响应
776776

@@ -787,7 +787,7 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
787787
}
788788
```
789789

790-
返回的`id`是新增的数据的新id
790+
返回的 `id` 是新增的数据的新主键值
791791

792792
#### C-1-4.测试修改
793793

@@ -822,7 +822,7 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
822822
}
823823
```
824824

825-
如果要对`json`类型操作的话，这样请求
825+
如果要对 `json` 类型操作的话，这样请求
826826

827827
```json
828828
{
@@ -834,9 +834,9 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
834834
}
835835
```
836836

837-
这里的`praiseUserIdList`是一个`json`类型的字段，在操作之前它是空的`[]`，提交以后它是`[123]`，如果再添加一个21，则会变成`[123,21]`
837+
这里的 `praiseUserIdList` 是一个 `json` 类型的字段，在操作之前它是空的 `[]`，提交以后它是 `[123]`，如果再添加一个 21，则会变成 `[123,21]`
838838

839-
要删除其中的值，把`+`变成`-`即可
839+
要删除其中的值，把 `+` 变成 `-` 即可。如果没有 `+`, `-` 符号，"praiseUserIdList": \[123] 将直接替换原本的值，可能丢失数据。
840840

841841
#### C-1-5.测试删除
842842

@@ -857,7 +857,7 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/
857857

858858
#### 1. 后台添加数据表
859859

860-
在自己的数据库里新增一个表，比如我这里新增`b_stone`
860+
在自己的数据库里新增一个表，比如我这里新增 `b_stone`
861861

862862
```sql
863863
-- 原石
@@ -873,7 +873,7 @@ CREATE TABLE `b_stone` (
873873
`modifydate` timestamp DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
874874
`modifier` varchar(80) NULL,
875875
PRIMARY KEY (`id`)
876-
)ENGINE=InnoDB DEFAULT CHARSET=utf8;
876+
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
877877
```
878878

879879
#### 2. 配置权限
@@ -945,23 +945,23 @@ static { //注册权限
945945
"type{}":[0,1,2]
946946
}
947947
```
948-
就能校验 type 的值是不是 0，1，2中的一个。<br />
948+
就能校验 type 的值是不是 0，1，2 中的一个。<br />
949949
还有 <br />
950950
```js
951951
"VERIFY": { "money&{}":">0,<=10000" } //自动验证是否 money>0 & money<=10000
952-
"TYPE": { "balance": "Double" } //自动验证balance类型是否为Double
953-
"UNIQUE": "phone" //强制phone的值为数据库中没有的
954-
"NECESSARY": "id,name" //强制传id,name两个字段
955-
"DISALLOW": "balance" //禁止传balance字段
956-
"INSERT": { "@role": "OWNER" } //如果没传@role就自动添加
952+
"TYPE": { "balance": "DECIMAL" } //自动验证 balance 类型是否为 DECIMAL（对应 Double 双精度浮点数）
953+
"UNIQUE": "phone" //强制 phone 的值为数据库中没有的
954+
"NECESSARY": "id,name" //强制传 id,name 两个字段
955+
"DISALLOW": "balance" //禁止传 balance 字段
956+
"INSERT": { "@role": "OWNER" } //如果没传 @role 就自动添加
957957
"UPDATE": { "id@": "User/id" } //强制放入键值对
958958
```
959959
全部操作符见 [Operation.java](https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/Operation.java) 的注释
960960
<br />
961961
<br />
962962

963963

964-
:first_quarter_moon_with_face:此处的介绍都只是简要介绍，只是为了引导刚刚接触APIJSON的道友快速了解APIJSON，并不代表APIJSON只有这些功能，具体功能详情参考下列图表
964+
:first_quarter_moon_with_face:此处的介绍都只是简要介绍，只是为了引导刚刚接触 APIJSON 的道友快速了解 APIJSON，并不代表 APIJSON 只有这些功能，具体功能详情参考下列图表
965965

966966
#### 4. 完整功能图表
967967
https://github.com/Tencent/APIJSON/blob/master/Document.md#3

0 commit comments

Comments
 (0)