@@ -865,53 +865,6 @@ static { //注册权限
865865:first_quarter_moon_with_face : 此处的介绍都只是简要介绍，只是为了引导刚刚接触APIJSON的道友快速了解APIJSON，并不代表APIJSON只有这些功能，具体功能详情参考下列图表
866866
867867#### 4. 完整功能图表
868-
869- ##### 4.1接口功能
870-
871- | 方法及说明 | URL | Request | Response |
872- | ------------------------------------------------------------ | ---------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
873- | GET: <br > 普通获取数据，<br > 可用浏览器调试 | base_url/get/ | {   ;  ; TableName:{   ;  ;  ;  ; … <br >   ;  ; }<br >} <br > {…}内为限制条件<br ><br > 例如获取一个id为235的Moment：<br >{<br >   ;  ; "Moment":{<br >   ;  ;  ;  ; "id":235<br >   ;  ; }<br >} | {<br >   ;  ; TableName:{<br >   ;  ;  ;  ; ...<br >   ;  ; },<br >   ;  ; "code":200,<br >   ;  ; "msg":"success"<br >}<br >例如<br >{<br >   ;  ; "Moment":{<br >   ;  ;  ;  ; "id":235,<br >   ;  ;  ;  ; "userId":38710,<br >   ;  ;  ;  ; "content":"APIJSON,let interfaces and documents go to hell !"<br >   ;  ; },<br >   ;  ; "code":200,<br >   ;  ; "msg":"success"<br > } |
874- | 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 >} |
875- | GETS: <br > 安全/私密获取数据，<br > 用于获取钱包等<br >对安全性要求高的数据 | base_url/gets/ | 最外层加一个"tag": tag ，其它同GET | 同GET |
876- | HEADS: <br > 安全/私密获取数量，<br > 用于获取银行卡数量等<br >对安全性要求高的数据总数 | base_url/heads/ | 最外层加一个"tag": tag ，其它同HEAD | 同HEAD |
877- | POST: <br > 新增数据 | base_url/post/ | {<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 > 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 >} |
878- | PUT: <br > 修改数据，<br > 只修改所传的字段 | base_url/put/ | {<br >   ;  ; TableName:{<br >   ;  ;  ;  ; "id": id ,<br >   ;  ;  ;  ; …<br >   ;  ; },<br >   ;  ; "tag": tag <br >} <br > {…}中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 >} | 同POST |
879- | DELETE: <br > 删除数据 | base_url/delete/ | {<br >   ;  ; TableName:{<br >   ;  ;  ;  ; "id": id <br >   ;  ; },<br >   ;  ; "tag": tag <br >} <br > {…}中id必传，一般只传id <br ><br >例如删除id为120的Moment：<br >{<br >   ;  ; "Moment":{<br >   ;  ;  ;  ; "id":120<br >   ;  ; },<br >   ;  ; "tag":"Moment"<br >} | 同POST |
880-
881- 1.TableName指要查询的数据库表Table的名称字符串。第一个字符为大写字母，剩下的字符要符合英语字母、数字、下划线中的任何一种。对应的值的类型为JSONObject，结构是 {...}，里面放的是Table的字段(列名)。下同。<br >
882- 2."tag": tag 后面的tag是非GET、HEAD请求中匹配请求的JSON结构的key，一般是要查询的table的名称，由后端Request表中指定。下同。<br >
883- 3.GET、HEAD请求是开放请求，可任意组合任意嵌套。其它请求为受限制的安全/私密请求，对应的 方法、tag、结构 都必须和 后端Request表中所指定的 一一对应，否则请求将不被通过。下同。<br >
884- 4.GETS与GET、HEADS与HEAD分别为同一类型的操作方法，请求稍有不同但返回结果相同。下同。<br >
885- 5.在HTTP通信中，GET、HEAD方法一般用HTTP GET请求，其它一般用HTTP POST请求。下同。<br >
886- 6.所有JSONObject都视为容器(或者文件夹)，结构为 {...} ，里面可以放普通对象或子容器。下同。<br >
887- 7.每个对象都有一个唯一的路径(或者叫地址)，假设对象名为refKey，则用 key0/key1/.../refKey 表示。下同。
888-
889- :notebook : 注意
890-
891- 1 . Oracle数据库直接使用的是当前时间的LONG值，作为插入时新数据ID的
892-
893- <br >
894-
895- ##### 4.1 功能符<h3 />
896-
897- | 功能 | 键值对格式 | 使用示例 |
898- | -------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
899- | 查询数组 | "key[ ] ":{}，后面是JSONObject，key可省略。当key和里面的Table名相同时，Table会被提取出来，即 {Table:{Content}} 会被转化为 {Content} | [ {"User[ ] ":{"User":{}}}] ( http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{}}} ) ，查询一个User数组。这里key和Table名都是User，User会被提取出来，即 {"User":{"id", ...}} 会被转化为 {"id", ...} |
900- | 匹配选项范围 | "key{}":[ ] ，后面是JSONArray，作为key可取的值的选项 | [ "id{}":[ 38710,82001,70793]] ( http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"id{}":[38710,82001,70793]}}} ) ，查询id符合38710,82001,70793中任意一个的一个User数组 |
901- | 匹配条件范围 | "key{}":"条件0,条件1..."，条件为任意SQL比较表达式字符串，非Number类型必须用''包含条件的值，如'a' | [ "id{}":"<=80000,\> 90000"] ( http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"id{}":"<=80000,\> 90000"}}} ) ，查询id符合id\< =80000 \| id>90000的一个User数组 |
902- | 包含选项范围 | "key<\> ": Object => "key<\> ":[ Object] ，key对应值的类型必须为JSONArray，Object类型不能为JSON | [ "contactIdList<\> ":38710] ( http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"contactIdList<\> ":38710}}} ) ，查询contactIdList包含38710的一个User数组 |
903- | 远程调用函数 | "key()":"函数表达式"，函数表达式为 function(key0,key1...)，会调用后端对应的函数 function(JSONObject request, String key0, String key1...) | [ "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点了赞） |
904- | 引用赋值 | "key@":"引用路径"，引用路径为用/分隔的字符串。以/开头的是缺省引用路径，从声明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 |
905- | 模糊搜索 | "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"}}} ) ，查询name包含"m"的一个User数组 |
906- | 正则匹配 | "key?":"正则表达式" => "key?":[ "正则表达式"] ，任意正则表达式字符串，如 ^[ 0-9] +$ ，可用于高级搜索 | [ "name?":"^[ 0-9] +$"] ( http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"name%253F":"^[0-9]%252B$"}}} ) ，查询name中字符全为数字的一个User数组 |
907- | 新建别名 | "name: alias "，name映射为alias，用alias替代name。可用于 column,Table,SQL函数 等。只用于GET类型、HEAD类型的请求 | [ "@column ":"toId: parentId "] ( http://apijson.cn:8080/get/{"Comment":{"@column":"id,toId:parentId","id":51}} ) ，将查询的字段toId变为parentId返回 |
908- | 增加 或 扩展 | "key+": Object ，Object的类型由key指定，且类型为Number,String,JSONArray中的一种。如 82001,"apijson",[ "url0","url1"] 等。只用于PUT请求 | "praiseUserIdList+":[ 82001] ，添加一个点赞用户id，即这个用户点了赞 |
909- | 减少 或 去除 | "key-": Object ，与"key+"相反 | "balance-":100.00，余额减少100.00，即花费了100元 |
910- | 逻辑运算 | &, \| , ! 逻辑运算符 <br /><br />① & 可用于"key&{}":"条件"等<br /><br />② \| 可用于"key\| {}":"条件", "key\| {}":[ ] 等，一般可省略<br /><br />③ ! 可单独使用，如"key!": Object ，也可像&,\| 一样配合其他功能符使用 | ① [ "id&{}":">80000,<=90000"] ( http://apijson.cn:8080/head/{"User":{"id&{}":">80000,<=90000"}} ) ，即id满足id>80000 & id<=90000<br /><br /> ② [ "id\| {}":">90000,<=80000"] ( http://apijson.cn:8080/head/{"User":{"id\| {}":">90000,<=80000"}} ) ，同"id{}":">90000,<=80000"，即id满足id>90000 \| id<=80000<br /><br /> ③ [ "id!{}":[ 82001,38710]] ( http://apijson.cn:8080/head/{"User":{"id!{}":[82001,38710]}} ) ，即id满足 ! (id=82001 \| id=38710)，可过滤黑名单的消息 |
911- | 数组关键词 | "key":Object，key为 "[]":{} 中{}内的关键词，Object的类型由key指定<br /><br />① "count":Integer，查询数量，假设允许查询数组的最大数量为max(默认为100)，则当count在1~max范围内时，查询count个；否则查询max个 <br /><br />② "page":Integer，查询页码，从0开始，一般和count一起用<br /><br />③ "query":Integer，查询内容<br />0-对象，1-总数，2-以上全部<br />总数关键词为total，和query同级，通过引用赋值得到，如 "total@":"/[]/total" <br />这里query及total仅为GET类型的请求提供方便，一般可直接用HEAD类型的请求获取总数<br /><br />④ "join":"&/Table0/key0@,\</Table1/key1@"<br />多表连接方式：<br /> "\<" - LEFT JOIN <br /> ">" - RIGHT JOIN <br /> "&" - INNER JOIN <br /> "\|" - FULL JOIN <br /> "!" - OUTTER JOIN <br /> | ① 查询User数组，最多5个：<br />["count":5](http://apijson.cn:8080/get/{"[]":{"count":5,"User":{}}})<br /><br /> ② 查询第3页的User数组，每页5个：<br />["count":5,<br />"page":3](http://apijson.cn:8080/get/{"[]":{"count":5,"page":3,"User":{}}})<br /><br /> ③ 查询User数组和对应的User总数：<br />["[]":{<br /> "query":2,<br /> "User":{}<br />},<br />"total@":"/[]/total"](http://apijson.cn:8080/get/{"[]":{"query":2,"count":5,"User":{}},"total@":"%252F[]%252Ftotal"})<br />总页数、是否有下一页等信息可通过 total,count,page 得出，<br />总页数 int totalPage = Math.ceil(total \/ count)<br />是否有下一页 boolean hasNextPage = total > count\*page<br />是否为第一页 boolean isFirstPage = page <= 0<br />是否为最后一页 boolean isLastPage = total <= count\*page<br />... <br /><br /> ④ Moment INNER JOIN User LEFT JOIN Comment：<br />["[]":{<br /> "join": "&/User/id@,\</Comment/momentId@",<br /> "Moment":{},<br /> "User":{<br /> "name?":"t",<br /> "id@": "/Moment/userId"<br /> },<br /> "Comment":{<br /> "momentId@": "/Moment/id"<br /> }<br />}](http://apijson.cn:8080/get/{"[]":{"count":5,"join":"&%252FUser%252Fid@,<%252FComment%252FmomentId@","Moment":{"@column":"id,userId,content"},"User":{"name%253F":"t","id@":"%252FMoment%252FuserId","@column":"id,name,head"},"Comment":{"momentId@":"%252FMoment%252Fid","@column":"id,momentId,content"}}}) |
912- | 对象关键词，可自定义 | "@key":Object，@key为 Table:{} 中{}内的关键词，Object的类型由@key指定<br /><br />① "@combine":"&key0,\|key1,!key2,..."，条件组合方式，\| 可省略<br /><br />② "@column":"column;function(arg)..."，返回字段<br /><br />③ "@order":"column0+,column1-..."，排序方式<br /><br />④ "@group":"column0,column1..."，分组方式。如果@column里声明了Table的id，则id也必须在@group中声明；其它情况下必须满足至少一个条件:<br />1.分组的key在@column里声明<br />2.Table主键在@group中声明 <br /><br />⑤ "@having":"function0(...)?value0;function1(...)?value1;function2(...)?value2..."，SQL函数条件，一般和@group一起用，函数一般在@column里声明<br /><br />⑥ "@otherKey": Object，自定义关键词，名称和以上系统关键词不一样，且原样返回上传的值 | ① 搜索name或tag任何一个字段包含字符a的User列表：<br />["name?":"a",<br />"tag?":"a",<br />"@combine":"name?,tag?"](http://apijson.cn:8080/get/{"User[]":{"count":10,"User":{"@column":"id,name,tag","name%253F":"a","tag%253F":"a","@combine":"name%253F,tag%253F"}}})<br /><br /> ② 只查询id,sex,name这几列并且请求结果也按照这个顺序：<br />["@column":"id,sex,name"](http://apijson.cn:8080/get/{"User":{"@column":"id,sex,name","id":38710}})<br /><br /> ③ 查询按 name降序、id默认顺序 排序的User数组：<br />["@order":"name-,id"](http://apijson.cn:8080/get/{"[]":{"count":10,"User":{"@column":"name,id","@order":"name-,id"}}})<br /><br /> ④ 查询按userId分组的Moment数组：<br />["@group":"userId,id"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":%7B"@column":"userId,id","@group":"userId,id"}}})<br /><br /> ⑤ 查询 按userId分组、id最大值>=100 的Moment数组：<br />["@column":"userId;max(id)",<br />"@group":"userId",<br />"@having":"max(id)>=100"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId%253Bmax(id)","@group":"userId","@having":"max(id)>=100"}}})<br />还可以指定函数返回名：<br />["@column":"userId;max(id):maxId",<br />"@group":"userId",<br />"@having":"maxId>=100"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId%253Bmax(id):maxId","@group":"userId","@having":"maxId>=100"}}})<br /><br /> ⑥ 从pictureList获取第0张图片：<br />["@position":0, //这里@position为自定义关键词<br />"firstPicture()":"getFromArray(pictureList,@position)"](http://apijson.cn:8080/get/{"User":{"id":38710,"@position":0,"firstPicture()":"getFromArray(pictureList,@position)"}}) |
913-
914- <br />
915-
868+ https://github.com/TommyLemon/APIJSON/blob/master/Document.md#3
916869
917870
0 commit comments