通用API: 一个接口解决90%的取数需求(附源码)

目录

1.背景

2.核心处理逻辑

3.使用示例

1.数据源配置

2.sql配置

3.分页调用

---

1.背景

1.大数据团队处理后的数据放在mysql里，给业务团队提供数据查询接口；如果case by case的开发接口，开发成本太高，得不偿失；
2.我们写了一个通用api的服务，通过配置数据源，SQL以及SQL参数，极大的减少了工作量；
3.支持多数据源、跨库查询、多表join、分页、匹配条件支持in、=、!=、>、>=、<、<=、like等；数值类型支持字符、日期、数字、数组等
4.记录api调用和异常日志

 

2.核心处理逻辑

1.添加数据源
2.添加API配置
3.调用接口
    1.通过druid构建并缓存数据源
    2.通过sql参数配置和请求参数构造sql
    3.执行sql返回数据并记录调用日志

 

3.使用示例

需求: 查询年龄等于20岁的学生名

swagger地址: http://localhost:8085/doc.html

1.数据源配置

{
    "name": "local",
    "password": "123456",
    "type": "mysql",
    "url": "jdbc:mysql://localhost:3306/test?autoReconnect=true&useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false",
    "username": "root"
}

2.sql配置

{
  "apiCode": "selectStudent",
  "apiName": "查询学生",
  "condition": {
    "age": {
      "express": "[$age]",
      "filed": "age",
      "match": "=",
      "type": "数字"
    }
  },
  "dataSourceId": "d06bfb7abbafbf7497d5eb06074869fb",
  "filedNote": {
    "name": "姓名"
  },
  "sql": "select name from student where 1=1 [$age]"
}

配置说明
1.apiCode: 调用api时的唯一标识
2.apiName: api的名称
3.condition: sql对应的多个过滤条件
    age作为的key,条件的唯一标识,api调用时请求体里的key
    express:占位符(调用接口时会根据sql配置和请求参数拼接where过滤条件)
    field:表的字段名
    match:匹配的类型
    type:值的类型(调用接口时会根据type改变值,例如类型是数组,传的值是[1,2],改变后是('1','2'))
4.dataSourceId: 数据源表的id
5.filedNote: 配置的sql的select字段说明
6.sql:查询的sql和占位符(sql必须要有where 1=1, 因为后面的查询条件会加and)

3.分页调用

curl -H "Content-Type:application/json" -X POST -d '{"age":20}' 'http://localhost:8085/api/data/selectStudent?pageNo=1&pageSize=1'

{"code":200,"msg":"请求成功","data":{"currentPage":1,"pageSize":1,"total":1,"pages":1,"records":[{"name":"张三丰"}]}}

 

shout out to panzhi

 

源码地址: https://github.com/ostarsier/common-api