@@ -6,13 +6,23 @@ https://github.com/Tencent/APIJSON/issues/468
6
6
7
7
#### 使用说明
8
8
9
- json支持多种方式定义method
9
+ json 支持多种方式定义 method
10
10
11
- 第一种:
11
+ #### 第一种:
12
12
13
- "@post ","@put ","@delete ","@head ","@get ","@gets ","@head ","@heads "
13
+ "@post ","@put ","@delete ","@head ","@get ","@gets ","@head ","@heads "
14
14
15
- "@post ": [ "Moment","Comment[ ] "] , 值为数组格式, 每个value = key
15
+ "@post ": "Moment,Comment[ ] " , 值为 String 或 JSONObject 格式, 为 String 时每个 value = key,为 JSONObject 时:
16
+ ``` json
17
+ "@post" : {
18
+ "Moment" : " Moment" , // 只指定 tag,为 "" 则和 key 一致
19
+ "Comment[]" : { // 同时指定多个全局关键词
20
+ "tag" : " Comment[]" ,
21
+ "version" : 2
22
+ // 其它全局关键词
23
+ }
24
+ }
25
+ ```
16
26
17
27
需要保证每个key唯一, 唯一判断标准:
18
28
@@ -24,7 +34,7 @@ key= Moment[]
24
34
25
35
```
26
36
{
27
- "@post": [ "Moment"," Comment:cArray[]"," User:u"] , // 分发到 POST 请求对应的解析处理
37
+ "@post": "Moment, Comment:cArray[], User:u", // 分发到 POST 请求对应的解析处理
28
38
"Moment": {
29
39
// TODO 其它字段
30
40
},
@@ -33,7 +43,7 @@ key= Moment[]
33
43
// TODO 其它字段
34
44
}
35
45
],
36
- "@get": [ "User"] , // 分发到 GET 请求对应的解析处理
46
+ "@get": "User", // 分发到 GET 请求对应的解析处理
37
47
"User:u": {
38
48
// TODO 其它字段
39
49
},
@@ -46,19 +56,19 @@ key= Moment[]
46
56
47
57
```
48
58
49
- 第二种:
59
+ #### 第二种: @ Deprecated 即将弃用,请使用第一种
50
60
51
61
对象内定义"@method ": "GET", value大写
52
62
53
63
```
54
64
{
55
- "sql@": {
65
+ "sql@": {
56
66
"@method": "GET",
57
67
"with": true,
58
68
"from": "Sys_role",
59
69
"Sys_role": {
60
- "@column": "id",
61
- "role_name": "角色1"
70
+ "@column": "id",
71
+ "role_name": "角色1"
62
72
}
63
73
},
64
74
"Sys_user_role:sur[]": {
@@ -152,14 +162,14 @@ Comment:cArray[]
152
162
153
163
并将method 添加到 json对象属性中.
154
164
155
- ```
165
+ ``` json
156
166
"Sys_role" : {
157
- "@method": "PUT",
158
- "id": "6aedce0d-2a29-4fbe-aeed-0ba935ca6b41",
159
- "id{}@": "sql",
160
- "role_code": "code-subrange-4",
161
- "role_name": "角色-subrange-4"
162
- }
167
+ "@method" : " PUT" ,
168
+ "id" : " 6aedce0d-2a29-4fbe-aeed-0ba935ca6b41" ,
169
+ "id{}@" : " sql" ,
170
+ "role_code" : " code-subrange-4" ,
171
+ "role_name" : " 角色-subrange-4"
172
+ }
163
173
```
164
174
165
175
2、对象解析
@@ -741,15 +751,18 @@ AbstractVerifier.IS_UPDATE_MUST_HAVE_ID_CONDITION = true; // true: 必须有
741
751
742
752
```
743
753
// 条件删除
754
+ ```json
744
755
{
745
756
"User:del": {
746
757
"username": "test3"
747
758
},
748
759
"tag": "User",
749
760
"explain": true
750
761
}
762
+ ```
751
763
752
764
// 引用id{}@删除
765
+ ``` json
753
766
{
754
767
"sql@" : {
755
768
"@method" : " GET" ,
@@ -766,8 +779,11 @@ AbstractVerifier.IS_UPDATE_MUST_HAVE_ID_CONDITION = true; // true: 必须有
766
779
},
767
780
"explan" : true
768
781
}
782
+ ```
783
+
769
784
// 子查询条件删除
770
785
http://localhost:8675/lowCodePlatform/forms/api/delete
786
+ ``` json
771
787
{
772
788
"sql@" : {
773
789
"@method" : " GET" ,
@@ -783,8 +799,10 @@ http://localhost:8675/lowCodePlatform/forms/api/delete
783
799
},
784
800
"explan" : true
785
801
}
802
+ ```
786
803
787
804
第二种写法:
805
+ ``` json
788
806
{
789
807
"@get" : [" sql@" ],
790
808
"sql@" : {
@@ -800,23 +818,21 @@ http://localhost:8675/lowCodePlatform/forms/api/delete
800
818
},
801
819
"explan" : true
802
820
}
803
-
804
-
805
821
```
806
822
807
823
808
824
809
825
开启id删除, 删除失败:
810
826
811
- ```
827
+ ``` json
812
828
{
813
- "@get": ["sql@"],
814
- "sql@": {
829
+ "@get" : [" sql@" ],
830
+ "sql@" : {
815
831
"with" : true ,
816
832
"from" : " User" ,
817
833
"User" : {
818
- "@column": "username",
819
- "username": "test4"
834
+ "@column" : " username" ,
835
+ "username" : " test4"
820
836
}
821
837
},
822
838
"User" : {
@@ -830,7 +846,7 @@ http://localhost:8675/lowCodePlatform/forms/api/delete
830
846
831
847
开启id删除、id引用 删除成功
832
848
833
- ```
849
+ ``` json
834
850
{
835
851
"sql@" : {
836
852
"@method" : " GET" ,
@@ -848,19 +864,20 @@ http://localhost:8675/lowCodePlatform/forms/api/delete
848
864
"explan" : true
849
865
}
850
866
```
867
+
851
868
![ image] ( https://user-images.githubusercontent.com/12228225/204080050-e6f04fe6-319e-45b7-b1b2-bf4cda4ab2db.png )
852
869
853
870
PUT 子查询 修改
854
871
855
- ```
872
+ ``` json
856
873
{
857
874
"sql@" : {
858
- "@method": "GET",
875
+ "@method" : " GET" ,
859
876
"with" : true ,
860
877
"from" : " Sys_role_permission" ,
861
878
"Sys_role_permission" : {
862
- "@column": "role_id",
863
- "id{}": ["ba2634f8-0bdc-4b50-9c5e-47786b1536ef"]
879
+ "@column" : " role_id" ,
880
+ "id{}" : [" ba2634f8-0bdc-4b50-9c5e-47786b1536ef" ]
864
881
}
865
882
},
866
883
"Sys_role" : {
@@ -892,15 +909,15 @@ WHERE ( (`username` IN (SELECT * FROM (SELECT `username` FROM `housekeeping`.`Us
892
909
893
910
### must、refuses判断、delete、PUT支持 ref
894
911
895
- ```
912
+ ``` json
896
913
{
897
- "sql@": {
898
- "@method": "GET",
914
+ "sql@" : {
915
+ "@method" : " GET" ,
899
916
"with" : true ,
900
917
"from" : " Sys_role_permission" ,
901
918
"Sys_role_permission" : {
902
- "@column": "id",
903
- "role_id{}": ["94f79f0b-331b-4cc5-bfc0-ebfc47d00f13"]
919
+ "@column" : " id" ,
920
+ "role_id{}" : [" 94f79f0b-331b-4cc5-bfc0-ebfc47d00f13" ]
904
921
}
905
922
},
906
923
"Sys_role_permission" : {
0 commit comments