Commit f613734
authored
Update Document.md
1 parent 987261f commit f613734
1 file changed
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -333,7 +333,7 @@ GET: <br > 普通获取数据，<br > 可用浏览器调试 | base_url/get/ | {< | |||
| 333 | 333 | HEAD: <br > 普通获取数量，<br > 可用浏览器调试 | base_url/head/ | {<br > TableName:{<br > …<br > }<br > } <br > {…}内为限制条件 <br ><br > 例如获取一个 id = 38710 的 User 所发布的 Moment 总数：<br >{<br > "Moment":{<br > "userId":38710<br > }<br >} | {<br > TableName:{<br > "code":200,<br > "msg":"success",<br > "count":10<br > },<br > "code":200,<br > "msg":"success"<br >} <br > 例如<br >{<br > "Moment":{<br > "code":200,<br > "msg":"success",<br > "count":10<br > },<br > "code":200,<br > "msg":"success"<br >} | |
| 334 | 334 | GETS: <br > 安全/私密获取数据，<br > 用于获取钱包等<br >对安全性要求高的数据 | base_url/gets/ | 最外层加一个 "tag":tag，其它同GET | 同GET | |
| 335 | 335 | HEADS: <br > 安全/私密获取数量，<br > 用于获取银行卡数量等<br >对安全性要求高的数据总数 | base_url/heads/ | 最外层加一个 "tag":tag，其它同HEAD | 同HEAD | |
| 336 | - POST: <br > 新增数据 | base_url/post/ | 单个： <br > {<br > TableName:{<br > …<br > },<br > "tag":tag<br >} <br > {…}中id由后端生成，不能传 <br ><br >例如一个 id = 38710 的 User 发布一个新 Moment：<br >{<br > "Moment":{<br > "userId":38710,<br > "content":"APIJSON,let interfaces and documents go to hell !"<br > },<br > "tag":"Moment"<br >}<br > 批量： <br > TableName\[]:\[{<br > …<br > }, {<br > …<br > }],<br > "tag":tag<br >} <br > {…}中id由后端生成，不能传 <br ><br >例如当前登录用户 82001 发布 2 个 Comment：<br >{<br > "Comment\[]":\[{<br > "momentId":12,<br > "content":"APIJSON,let interfaces and documents go to hell !"<br > }<br >}, {<br > "momentId":15,<br > "content":"APIJSON is a JSON transmision protocol."<br > }],<br > "tag":"Comment[]"<br >}<br > | 单个： <br > {<br > TableName:{<br > "code":200,<br > "msg":"success",<br > "id":38710<br > },<br > "code":200,<br > "msg":"success"<br >}<br >例如<br >{<br > "Moment":{<br > "code":200,<br > "msg":"success",<br > "id":120<br > },<br > "code":200,<br > "msg":"success"<br >} <br > 批量： <br > {<br > TableName\[]:{<br > "code":200,<br > "msg":"success",<br > "count":2,<br > "id[]":[1, 2]<br > },<br > "code":200,<br > "msg":"success"<br >}<br >例如<br >{<br > "Comment\[]":{<br > "code":200,<br > "msg":"success",<br > "count":2,<br > "id[]":\[1, 2]<br > },<br > "code":200,<br > "msg":"success"<br >} | ||
| 336 | + POST: <br > 新增数据 | base_url/post/ | 单个： <br > {<br > TableName:{<br > …<br > },<br > "tag":tag<br >} <br > {…}中id由后端生成，不能传 <br ><br >例如一个 id = 38710 的 User 发布一个新 Moment：<br >{<br > "Moment":{<br > "userId":38710,<br > "content":"APIJSON,let interfaces and documents go to hell !"<br > },<br > "tag":"Moment"<br >}<br > <br > 批量： <br > TableName\[]:\[{<br > …<br > }, {<br > …<br > }],<br > "tag":tag<br >} <br > {…}中id由后端生成，不能传 <br ><br >例如当前登录用户 82001 发布 2 个 Comment：<br >{<br > "Comment\[]":\[{<br > "momentId":12,<br > "content":"APIJSON,let interfaces and documents go to hell !"<br > }<br >}, {<br > "momentId":15,<br > "content":"APIJSON is a JSON transmision protocol."<br > }],<br > "tag":"Comment[]"<br >}<br > | 单个： <br > {<br > TableName:{<br > "code":200,<br > "msg":"success",<br > "id":38710<br > },<br > "code":200,<br > "msg":"success"<br >}<br >例如<br >{<br > "Moment":{<br > "code":200,<br > "msg":"success",<br > "id":120<br > },<br > "code":200,<br > "msg":"success"<br >} <br > <br > 批量： <br > {<br > TableName\[]:{<br > "code":200,<br > "msg":"success",<br > "count":2,<br > "id[]":[1, 2]<br > },<br > "code":200,<br > "msg":"success"<br >}<br >例如<br >{<br > "Comment\[]":{<br > "code":200,<br > "msg":"success",<br > "count":2,<br > "id[]":\[1, 2]<br > },<br > "code":200,<br > "msg":"success"<br >} | ||
| 337 | 337 | PUT: <br > 修改数据，<br > 只修改所传的字段 | base_url/put/ | {<br > TableName:{<br > "id":id,<br > …<br > },<br > "tag":tag<br >} <br > {…} 中 id 或 id{} 至少传一个 <br ><br >例如修改 id = 235 的 Moment 的 content：<br >{<br > "Moment":{<br > "id":235,<br > "content":"APIJSON,let interfaces and documents go to hell !"<br > },<br > "tag":"Moment"<br >} <br > <br > 批量除了 id{}:\[] 也可类似批量 POST，只是每个 {...} 里面都必须有 id | 同POST | |
| 338 | 338 | DELETE: <br > 删除数据 | base_url/delete/ | {<br > TableName:{<br > "id":id<br > },<br > "tag":tag<br >} <br > {…} 中 id 或 id{} 至少传一个，一般只传 id 或 id{} <br ><br >例如批量删除 id = 100,110,120 的 Comment：<br >{<br > "Comment":{<br > "id{}":[100,110,120]<br > },<br > "tag":"Comment[]"<br >} | {<br > TableName:{<br > "code":200,<br > "msg":"success",<br > "id[]":[100,110,120]<br > "count":3<br > },<br > "code":200,<br > "msg":"success"<br >}<br >例如<br >{<br > "Comment":{<br > "code":200,<br > "msg":"success",<br > "id[]":[100,110,120],<br > "count":3<br > },<br > "code":200,<br > "msg":"success"<br >} | |
| 339 | 339 | ||
@@ -357,7 +357,8 @@ DELETE: <br > 删除数据 | base_url/delete/ | {<br > TableName:{< | |||
| 357 | 357 | 匹配条件范围 | "key{}":"条件0,条件1..."，条件为任意SQL比较表达式字符串，非Number类型必须用''包含条件的值，如'a' | ["id{}":"<=80000,\>90000"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"id{}":"<=80000,\>90000"}}})，对应SQL是`id<=80000 OR id>90000`，查询id符合id\<=80000 \| id>90000的一个User数组 | |
| 358 | 358 | 包含选项范围 | "key<\>":Object => "key<\>":[Object]，key对应值的类型必须为JSONArray，Object类型不能为JSON | ["contactIdList<\>":38710](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"contactIdList<\>":38710}}})，对应SQL是`json_contains(contactIdList,38710)`，查询contactIdList包含38710的一个User数组 | |
| 359 | 359 | 判断是否存在 | "key}{@":{<br /> "from":"Table",<br /> "Table":{ ... }<br />}<br />其中：<br />}{ 表示 EXISTS；<br /> key 用来标识是哪个判断；<br /> @ 后面是 子查询 对象，具体见下方 子查询 的说明。 | ["id}{@":{<br /> "from":"Comment",<br /> "Comment":{<br /> "momentId":15 <br /> }<br />}](http://apijson.cn:8080/get/{"User":{"id}{@":{"from":"Comment","Comment":{"momentId":15}}}})<br /> WHERE EXISTS(SELECT * FROM Comment WHERE momentId=15) | |
| 360 | - 远程调用函数 | "key()":"函数表达式"，函数表达式为 function(key0,key1...)，会调用后端对应的函数 function(JSONObject request, String key0, String key1...)，实现 参数校验、数值计算、数据同步、消息推送、字段拼接、结构变换 等特定的业务逻辑处理，<br>可使用 - 和 + 表示优先级，解析 key-() > 解析当前对象 > 解析 key() > 解析子对象 > 解析 key+() | ["isPraised()":"isContain(praiseUserIdList,userId)"](http://apijson.cn:8080/get/{"Moment":{"id":301,"isPraised()":"isContain(praiseUserIdList,userId)"}})，会调用 boolean isContain(JSONObject request, String array, String value) 函数，然后变为 "isPraised":true 这种（假设点赞用户id列表包含了userId，即这个User点了赞） | ||
| 360 | + 远程调用函数 | "key()":"函数表达式"，函数表达式为 function(key0,key1...)，会调用后端对应的函数 function(JSONObject request, String key0, String key1...)，实现 参数校验、数值计算、数据同步、消息推送、字段拼接、结构变换 等特定的业务逻辑处理，<br>可使用 - 和 + 表示优先级，解析 key-() > 解析当前对象 > 解析 key() > 解析子对象 > 解析 key+() | ["isPraised()":"isContain(praiseUserIdList,userId)"](http://apijson.cn:8080/get/{"Moment":{"id":301,"isPraised()":"isContain(praiseUserIdList,userId)"}})，会调用远程函数 boolean isContain(JSONObject request, String array, String value) ，然后变为 "isPraised":true 这种（假设点赞用户id列表包含了userId，即这个User点了赞） | ||
| 361 | + 存储过程 | "@key()":"SQL函数表达式"，函数表达式为 function(key0,key1...)，会调用后端数据库对应的存储过程 SQL函数 function(String key0, String key1...)，除了参数会提前赋值，其它和 远程函数一致 | ["@limit":10, <br /> "@offset":0, <br /> "@procedure()":"getCommentByUserId(id,@limit,@offset)"](http://apijson.cn:8080/get/{"User":{"@limit":10,"@offset":0,"@procedure()":"getCommentByUserId(id,@limit,@offset)}})，会调用存储过程 SQL 函数 getCommentByUserId(IN id bigint, IN limit int, IN offset int) ，然后变为 <br />"@procedure":{<br /> "count":-1, <br /> "update":false, <br /> "list":[] <br /> } <br /> 这种 | ||
| 361 | 362 | 引用赋值 | "key@":"key0/key1/.../refKey"，引用路径为用/分隔的字符串。以/开头的是缺省引用路径，从声明key所处容器的父容器路径开始；其它是完整引用路径，从最外层开始。<br /> 被引用的refKey必须在声明key的上面。如果对refKey的容器指定了返回字段，则被引用的refKey必须写在@column对应的值内，例如 "@column":"refKey,key1,..." | ["Moment":{<br /> "userId":38710<br />},<br />"User":{<br /> "id@":"/Moment/userId"<br />}](http://apijson.cn:8080/get/{"Moment":{"userId":38710},"User":{"id@":"%252FMoment%252FuserId"}})<br /> User内的id引用了与User同级的Moment内的userId，<br />即User.id = Moment.userId，请求完成后<br > "id@":"/Moment/userId" 会变成 "id":38710 | |
| 362 | 363 | 子查询 | "key@":{<br /> "range":"ALL", <br /> "from":"Table",<br /> "Table":{ ... }<br />}<br />其中：<br />range 可为 ALL,ANY；<br />from 为目标表 Table 的名称；<br />@ 后面的对象类似数组对象，可使用 count 和 join 等功能。 | ["id@":{<br /> "from":"Comment",<br /> "Comment":{<br /> "@column":"min(userId)" <br /> }<br />}](http://apijson.cn:8080/get/{"User":{"id@":{"from":"Comment","Comment":{"@column":"min(userId)"}}}})<br /> WHERE id=(SELECT min(userId) FROM Comment) | |
| 363 | 364 | 模糊搜索 | "key$":"SQL搜索表达式" => "key$":["SQL搜索表达式"]，任意SQL搜索表达式字符串，如 %key%(包含key), key%(以key开始), %k%e%y%(包含字母k,e,y) 等，%表示任意字符 | ["name$":"%m%"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"name$":"%2525m%2525"}}})，对应SQL是`name LIKE '%m%'`，查询name包含"m"的一个User数组 | |
0 commit comments