ZetaAPI动态生成 Api 文档

ZetaAPI 是一个使用 SQL + XML 快速创建 Api 接口与使用文档的框架，帮助开发者提升开发效率。

框架特性

1. 配置简单功能丰富
2. 使用xml标签属性就可支持缓存，默认缓存实现为caffeine，也可自定义缓存实现
3. 标签内if分支判断，用于处理各种复杂场景
4. 自定义访问拦截，可通过创建拦截器修改表达式与返回结果
5. 动态生成Api文档，可以方便的查看API接口，支持在线测试与接口编辑
6. 支持xml热更新，无需重启容器，即可读取最新xml配置

使用方法

1. 创建spring boot项目，添加zeta-api依赖
2. 配置数据库连接与数据库驱动
3. 入口类设置注解扫描路径 @SpringBootApplication(scanBasePackages = "xyz.erupt")
4. 创建配置文件，/resources/epi/xxx.xml
5. xml文件示范例

<?xml version="1.0" encoding="utf-8" ?>
<zeta desc="zeta接口示例">
    <hello-world title="基础使用">
        select 'hello world' $key
    </hello-world>

    <cache cache="5000" title="使用缓存(cache单位毫秒)">
        select 'cache',now() now
    </cache>

    <params title="参数获取与处理">
        <param key="param" default="hello zeta" title="返回值"/>
        select :param param
    </params>

    <condition title="条件处理">
        <param key="param" default="" title="数值"/>
        select
        <if test="param > 10">
            'gt 10' param_status
        </if>
        <if test="param < 10">
            'lt 10' param_status
        </if>
        <if test="param == 10">
            'eq 10' param_status
        </if>
    </condition>

    <insert title="插入数据">
        <param key="content" title="待插入数据"/>
        insert into demo(content) values (:content)
    </insert>
</zeta>

启动项目，查看接口文档：http://host/zeta−doc/host/zeta−doc/{xml文件名}.html

application.yml配置项说明

zeta-api:
  #是否热读取xml配置，生产环境不要开启此功能
  hotReadXml: true
  #是否开始缓存功能
  enableCache: true
  #是否开启Api文档查询功能
  enableApiDoc: true
  #自定义缓存实现，需实现xyz.erupt.zeta_api.handler.ZetaCache接口
  cacheHandlerPath: xyz.erupt.xxxx
  #是否打印sql语句
  showSql: true
  #访问白名单，空表示不对ip进行鉴权
  ipWhite:
    - 127.0.0.1
    - 192.168.1.1
    - 192.168.1.187

接口请求示例

// jquery为例
$.ajax({
    type: "POST",
    url: "/zeta-api/sql/{file}/{name}",
    contentType: "application/json",    //请求内容需要为json
    data: JSON.stringify({ param: 10}), //必须使用JSON.stringify
    success: function (res) {
        alert(res);
    }
});