# 完整功能图表
# 接口功能
方法及说明 | URL | Request | Response |
---|---|---|---|
GET: 普通获取数据, 可用浏览器调试 | base_url/get/ | { TableName:{ … } } {…}内为限制条件 例如获取一个id为235的Moment: { "Moment":{ "id":235 } } | { TableName:{ ... }, "code":200, "msg":"success" } 例如 { "Moment":{ "id":235, "userId":38710, "content":"APIJSON,let interfaces and documents go to hell !" }, "code":200, "msg":"success" } |
HEAD: 普通获取数量, 可用浏览器调试 | base_url/head/ | { TableName:{ … } } {…}内为限制条件 例如获取一个id为38710的User所发布的Moment总数: { "Moment":{ "userId":38710 } } | { TableName:{ "code":200, "msg":"success", "count":10 }, "code":200, "msg":"success" } 例如 { "Moment":{ "code":200, "msg":"success", "count":10 }, "code":200, "msg":"success" } |
GETS: 安全/私密获取数据, 用于获取钱包等 对安全性要求高的数据 | base_url/gets/ | 最外层加一个"tag":tag,其它同GET | 同GET |
HEADS: 安全/私密获取数量, 用于获取银行卡数量等 对安全性要求高的数据总数 | base_url/heads/ | 最外层加一个"tag":tag,其它同HEAD | 同HEAD |
POST: 新增数据 | base_url/post/ | { TableName:{ … }, "tag":tag } {…}中id由后端生成,不能传 例如一个id为38710的User发布一个新Moment: { "Moment":{ "userId":38710, "content":"APIJSON,let interfaces and documents go to hell !" }, "tag":"Moment" } | { TableName:{ "code":200, "msg":"success", "id":38710 }, "code":200, "msg":"success" } 例如 { "Moment":{ "code":200, "msg":"success", "id":120 }, "code":200, "msg":"success" } |
PUT: 修改数据, 只修改所传的字段 | base_url/put/ | { TableName:{ "id":id, … }, "tag":tag } {…}中id必传 例如修改id为235的Moment的content: { "Moment":{ "id":235, "content":"APIJSON,let interfaces and documents go to hell !" }, "tag":"Moment" } | 同POST |
DELETE: 删除数据 | base_url/delete/ | { TableName:{ "id":id }, "tag":tag } {…}中id必传,一般只传id 例如删除id为120的Moment: { "Moment":{ "id":120 }, "tag":"Moment" } | 同POST |
1.TableName指要查询的数据库表Table的名称字符串。第一个字符为大写字母,剩下的字符要符合英语字母、数字、下划线中的任何一种。对应的值的类型为JSONObject,结构是 {...},里面放的是Table的字段(列名)。下同。
2."tag":tag 后面的tag是非GET、HEAD请求中匹配请求的JSON结构的key,一般是要查询的table的名称,由后端Request表中指定。下同。
3.GET、HEAD请求是开放请求,可任意组合任意嵌套。其它请求为受限制的安全/私密请求,对应的 方法、tag、结构 都必须和 后端Request表中所指定的 一一对应,否则请求将不被通过。下同。
4.GETS与GET、HEADS与HEAD分别为同一类型的操作方法,请求稍有不同但返回结果相同。下同。
5.在HTTP通信中,GET、HEAD方法一般用HTTP GET请求,其它一般用HTTP POST请求。下同。
6.所有JSONObject都视为容器(或者文件夹),结构为 {...} ,里面可以放普通对象或子容器。下同。
7.每个对象都有一个唯一的路径(或者叫地址),假设对象名为refKey,则用 key0/key1/.../refKey 表示。下同。
📓注意
- Oracle数据库直接使用的是当前时间的LONG值,作为插入时新数据ID的
# 功能符
功能 | 键值对格式 | 使用示例 |
---|---|---|
查询数组 | "key[]":{},后面是JSONObject,key可省略。当key和里面的Table名相同时,Table会被提取出来,即 {Table:{Content}} 会被转化为 {Content} | {"User[]":{"User":{}}} (opens new window),查询一个User数组。这里key和Table名都是User,User会被提取出来,即 {"User":{"id", ...}} 会被转化为 {"id", ...} |
匹配选项范围 | "key{}":[],后面是JSONArray,作为key可取的值的选项 | "id{}":[38710,82001,70793] (opens new window),查询id符合38710,82001,70793中任意一个的一个User数组 |
匹配条件范围 | "key{}":"条件0,条件1...",条件为任意SQL比较表达式字符串,非Number类型必须用''包含条件的值,如'a' | "id{}":"<=80000,>90000" (opens new window),查询id符合id<=80000 | id>90000的一个User数组 |
包含选项范围 | "key<>":Object => "key<>":[Object],key对应值的类型必须为JSONArray,Object类型不能为JSON | "contactIdList<>":38710 (opens new window),查询contactIdList包含38710的一个User数组 |
远程调用函数 | "key()":"函数表达式",函数表达式为 function(key0,key1...),会调用后端对应的函数 function(JSONObject request, String key0, String key1...) | "isPraised()":"isContain(praiseUserIdList,userId)" (opens new window),会调用 boolean isContain(JSONObject request, String array, String value) 函数,然后变为 "isPraised":true 这种(假设点赞用户id列表包含了userId,即这个User点了赞) |
引用赋值 | "key@":"引用路径",引用路径为用/分隔的字符串。以/开头的是缺省引用路径,从声明key所处容器的父容器路径开始;其它是完整引用路径,从最外层开始。 被引用的refKey必须在声明key的上面。如果对refKey的容器指定了返回字段,则被引用的refKey必须写在@column对应的值内,例如 "@column":"refKey,key1,..." | "Moment":{ "userId":38710 }, "User":{ "id@":"/Moment/userId" } (opens new window) User内的id引用了与User同级的Moment内的userId, 即User.id = Moment.userId,请求完成后 "id@":"/Moment/userId" 会变成 "id":38710 |
模糊搜索 | "key$":"SQL搜索表达式" => "key$":["SQL搜索表达式"],任意SQL搜索表达式字符串,如 %key%(包含key), key%(以key开始), %k%e%y%(包含字母k,e,y) 等,%表示任意字符 | "name$":"%m%" (opens new window),查询name包含"m"的一个User数组 |
正则匹配 | "key?":"正则表达式" => "key?":["正则表达式"],任意正则表达式字符串,如 ^[0-9]+$ ,可用于高级搜索 | "name?":"^[0-9]+$" (opens new window),查询name中字符全为数字的一个User数组 |
新建别名 | "name:alias",name映射为alias,用alias替代name。可用于 column,Table,SQL函数 等。只用于GET类型、HEAD类型的请求 | "@column":"toId:parentId" (opens new window),将查询的字段toId变为parentId返回 |
增加 或 扩展 | "key+":Object,Object的类型由key指定,且类型为Number,String,JSONArray中的一种。如 82001,"apijson",["url0","url1"] 等。只用于PUT请求 | "praiseUserIdList+":[82001],添加一个点赞用户id,即这个用户点了赞 |
减少 或 去除 | "key-":Object,与"key+"相反 | "balance-":100.00,余额减少100.00,即花费了100元 |
逻辑运算 | &, |, ! 逻辑运算符 ① & 可用于"key&{}":"条件"等 ② | 可用于"key|{}":"条件", "key|{}":[]等,一般可省略 ③ ! 可单独使用,如"key!":Object,也可像&,|一样配合其他功能符使用 | ① "id&{}":">80000,<=90000" (opens new window),即id满足id>80000 & id<=90000 ② "id|{}":">90000,<=80000" (opens new window),同"id{}":">90000,<=80000",即id满足id>90000 | id<=80000 ③ "id!{}":[82001,38710] (opens new window),即id满足 ! (id=82001 | id=38710),可过滤黑名单的消息 |
数组关键词 | "key":Object,key为 "[]":{} 中{}内的关键词,Object的类型由key指定 ① "count":Integer,查询数量,假设允许查询数组的最大数量为max(默认为100),则当count在1~max范围内时,查询count个;否则查询max个 ② "page":Integer,查询页码,从0开始,一般和count一起用 ③ "query":Integer,查询内容 0-对象,1-总数,2-以上全部 总数关键词为total,和query同级,通过引用赋值得到,如 "total@":"/[]/total" 这里query及total仅为GET类型的请求提供方便,一般可直接用HEAD类型的请求获取总数 ④ "join":"&/Table0/key0@,</Table1/key1@" 多表连接方式: "<" - LEFT JOIN ">" - RIGHT JOIN "&" - INNER JOIN "|" - FULL JOIN "!" - OUTTER JOIN | ① 查询User数组,最多5个: "count":5 (opens new window) ② 查询第3页的User数组,每页5个: "count":5, "page":3 (opens new window) ③ 查询User数组和对应的User总数: "[]":{ "query":2, "User":{} }, "total@":"/[]/total" (opens new window) 总页数、是否有下一页等信息可通过 total,count,page 得出, 总页数 int totalPage = Math.ceil(total / count) 是否有下一页 boolean hasNextPage = total > count*page 是否为第一页 boolean isFirstPage = page <= 0 是否为最后一页 boolean isLastPage = total <= count*page ... ④ Moment INNER JOIN User LEFT JOIN Comment: "[]":{ "join": "&/User/id@,</Comment/momentId@", "Moment":{}, "User":{ "name?":"t", "id@": "/Moment/userId" }, "Comment":{ "momentId@": "/Moment/id" } } (opens new window) |
对象关键词,可自定义 | "@key":Object,@key为 Table:{} 中{}内的关键词,Object的类型由@key指定 ① "@combine":"&key0,|key1,!key2,...",条件组合方式,| 可省略 ② "@column":"column;function(arg)...",返回字段 ③ "@order":"column0+,column1-...",排序方式 ④ "@group":"column0,column1...",分组方式。如果@column里声明了Table的id,则id也必须在@group中声明;其它情况下必须满足至少一个条件: 1.分组的key在@column里声明 2.Table主键在@group中声明 ⑤ "@having":"function0(...)?value0;function1(...)?value1;function2(...)?value2...",SQL函数条件,一般和@group一起用,函数一般在@column里声明 ⑥ "@otherKey": Object,自定义关键词,名称和以上系统关键词不一样,且原样返回上传的值 | ① 搜索name或tag任何一个字段包含字符a的User列表: "name?":"a", "tag?":"a", "@combine":"name?,tag?" (opens new window) ② 只查询id,sex,name这几列并且请求结果也按照这个顺序: "@column":"id,sex,name" (opens new window) ③ 查询按 name降序、id默认顺序 排序的User数组: "@order":"name-,id" (opens new window) ④ 查询按userId分组的Moment数组: "@group":"userId,id" (opens new window) ⑤ 查询 按userId分组、id最大值>=100 的Moment数组: "@column":"userId;max(id)", "@group":"userId", "@having":"max(id)>=100" (opens new window) 还可以指定函数返回名: "@column":"userId;max(id):maxId", "@group":"userId", "@having":"maxId>=100" (opens new window) ⑥ 从pictureList获取第0张图片: "@position":0, //这里@position为自定义关键词 "firstPicture()":"getFromArray(pictureList,@position)" (opens new window) |
← 新增接口