ZetaAPI 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
ZetaAPI 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
ZetaAPI 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 MIT
开发语言 Java
操作系统 跨平台
软件类型 开源软件
所属分类 程序开发XML相关工具
开源组织
地区 不详
投 递 者 erupts
适用人群 未知
收录时间 2020-12-18

软件简介

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
img

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);
    }
});

 

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击加入讨论🔥(1)
暂无内容
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
暂无内容
1 评论
4 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部