ZetaAPI 动态生成 Api 文档开源项目

我要开发同款
匿名用户2020年12月18日
32阅读
开发技术Java
所属分类程序开发、XML相关工具
授权协议MIT

作品详情

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

框架特性配置简单功能丰富使用xml标签属性就可支持缓存,默认缓存实现为caffeine,也可自定义缓存实现标签内if分支判断,用于处理各种复杂场景自定义访问拦截,可通过创建拦截器修改表达式与返回结果动态生成Api文档,可以方便的查看API接口,支持在线测试与接口编辑支持xml热更新,无需重启容器,即可读取最新xml配置使用方法创建springboot项目,添加zeta-api依赖配置数据库连接与数据库驱动入口类设置注解扫描路径@SpringBootApplication(scanBasePackages="xyz.erupt")创建配置文件,/resources/epi/xxx.xmlxml文件示范例<?xmlversion="1.0"encoding="utf-8"?><zetadesc="zeta接口示例"><hello-worldtitle="基础使用">select'helloworld'$key</hello-world><cachecache="5000"title="使用缓存(cache单位毫秒)">select'cache',now()now</cache><paramstitle="参数获取与处理"><paramkey="param"default="hellozeta"title="返回值"/>select:paramparam</params><conditiontitle="条件处理"><paramkey="param"default=""title="数值"/>select<iftest="param>10">'gt10'param_status</if><iftest="param<10">'lt10'param_status</if><iftest="param==10">'eq10'param_status</if></condition><inserttitle="插入数据"><paramkey="content"title="待插入数据"/>insertintodemo(content)values(:content)</insert></zeta>启动项目,查看接口文档:https://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",//请求内容需要为jsondata:JSON.stringify({param:10}),//必须使用JSON.stringifysuccess:function(res){alert(res);}}); 
声明:本文仅代表作者观点,不代表本站立场。如果侵犯到您的合法权益,请联系我们删除侵权资源!如果遇到资源链接失效,请您通过评论或工单的方式通知管理员。未经允许,不得转载,本站所有资源文章禁止商业使用运营!
下载安装【程序员客栈】APP
实时对接需求、及时收发消息、丰富的开放项目需求、随时随地查看项目状态

评论