APIJSON - 功能符、数组关键词、对象关键词、全局关键词简表速查

点击上方“青年码农”关注

回复“源码”可获取各种资料

一 功能符号

数据库表中的字段用key代替

[]:查询数组

"key[]":{}
  

{}:匹配选项范围

"key{}":[1,2,3]
  

{}:匹配条件范围

"key{}":"<=10;length(key)>1..."
  

<>:包含选项范围

"key<>":38710
  

}{@:判断是否存在

"key}{@":{}
  

():远程调用函数

"key()":"function(arg0,arg1...)"
  

@key():存储过程

"@key()":"function(arg0,arg1...)"
  

key@:引用赋值

"key@":"key0/key1.../targetKey"
  

key@:子查询

   

    

     

      

     
     

      

       "key@":{
      
     
    

     

      

     
     

      

          "range":"ALL",
      
     
    

     

      

     
     

      

          "from":"Table",
      
     
    

     

      

     
     

      

          "Table":{ ... }
      
     
    

     

      

     
     

      

       }
      
     
   
  

$:模糊搜索

"key$":"%abc%"
  

~:正则匹配

"key~":"^[0-9]+$"
  

%:连续范围

"key%":"2018-01-01,2018-10-01"
  

+:增加/扩展

"key+":[1]
  

-:减少/去除

"key-":888.88
  

>:比较运算

"key{}":"<=90000"
  

• ">"   大于

• "<"   小于

• ">="  大于等于

• "<="  小于等于

&:逻辑运算符

"key&{}":">80000,<=90000" // &, |, !
  

• "&"   与（并且）

• "|"   或（或者）

• "！"  非（不等于）

新建别名

"key:alias"
  

二 数组关键词

"key":Object，key为 "[]":{} 中{}内的关键词，Object的类型由key指定 可以理解为下面这种格式

   

    

     

      

     
     

      

       "[]":{
      
     
    

     

      

     
     

      

          "User":{},
      
     
    

     

      

     
     

      

          "query":2,
      
     
    

     

      

     
     

      

          "count":1,
      
     
    

     

      

     
     

      

          ......
      
     
    

     

      

     
     

      

       },
      
     
   
  

查询数量

"count":1
  

查询页码

"page":1
  

查询内容

"query":Integer
  

• 0   对象

• 1   总数和分页详情

• 2   数据、总数和分页详情

关联

"join":"&/Table0,</Table1/key1@"
  

• "@"   APP JOIN

• "<"   LEFT JOIN

• ">"   RIGHT JOIN

• "&"   INNER JOIN

• "|"   FULL JOIN

• "!"   OUTER JOIN

• "*"   CROSS JOIN

• "^"   SIDE JOIN

• "("   ANTI JOIN

• ")"   FOREIGN JOIN

自定义关键词

"otherKey":Object
  

三 对象关键词

"@key":Object，@key为 Table:{} 中{}内的关键词，Object的类型由@key指定 下面这种格式

   

    

     

      

     
     

      

       "Table": {
      
     
    

     

      

     
     

      

          "@column":"key,key1",
      
     
    

     

      

     
     

      

       }
      
     
   
  

条件组合

"@combine":"key0 | (key1 & (key2 | !key3))..."
  

返回字段

"@column":"column;function(arg)..."
  

排序方式

"@order":"column0+,column1-..."
  

分组方式

"@group":"column0,column1..."
  

聚合条件HAVING

"@having":"function0(...)?value0;function1(...)?value1;function2(...)?value2..."
  

集合空间

"@schema":"sys"
  

数据库类型

"@database":"POSTGRESQL"
  

跨数据源

"@datasource":"DRUID"
  

转为 JSON 格式返回

"@json":"key0,key1..."
  

来访角色

"@role":"OWNER"
  

性能分析

"@explain":true
  

自定义原始SQL片段

"@raw":"key0,key1..."
  

自定义关键词

"@otherKey":Object
  

四 全局关键词

为最外层对象 {} 内的关键词。

集合空间

"@schema":"sys"
  

跨数据源

"@datasource":"DRUID"
  

来访角色

"@role":"OWNER"
  

性能分析

"@explain":true
  

参数校验

"tag":String
  

接口版本

"version":Integer
  

格式化

"format":Boolean
  

五 参考文档

APIJSON功能符：https://github.com/Tencent/APIJSON/blob/master/Document.md#32-%E5%8A%9F%E8%83%BD%E7%AC%A6

APIJSON目前实现功能：https://github.com/Tencent/APIJSON/wiki#APIJSON%E7%9B%AE%E5%89%8D%E5%B7%B2%E5%AE%9E%E7%8E%B0