开源项目介绍｜APIJSON- 后端零代码接口和文档ORM 库

女爷i 2022-10-07 03:56 10阅读 0赞

**2021腾讯犀牛鸟开源人才培养计划**

**开源项目介绍**

滑至文末报名参与开源人才培养计划

提交项目Proposal

![58be94ce2d73070b42096002d8314145.gif][]

![d03eb46cc4f9265940a542f5a6fe961d.png][]

**APIJSON项目介绍**

**标签：后端, ORM 库**

**技术栈：java**

![98830631bc19a2b6bfbf6a821177de3c.png][]

***APIJSON- 后端零代码接口和文档ORM 库，***赋能前端(客户端) 定制返回 JSON 的数据和结构。大幅提振开发效率、强力杜绝联调扯皮、巧妙规避文档缺陷、非常节省流量带宽。

![1f03a3225fa12aabbf1b4f1896d01fe6.png][]

![cee21f13a7f2c5b8387ab6a1c2c93376.png][]

**APIJSON项目导师介绍**

![format_png][]

**周作彪**

APIJSON, ZBLibrary 等热门开源项目的作者及布道师，QECon 大会讲师

***导师寄语：***

“APIJSON 是一个业内颇具影响力的后端知名热门项目，企业案例丰富、应用场景广泛、腾讯内外获得多个奖项和多次受邀演讲，这个零代码接口和文档 ORM 库随着 Serverless 的兴起会越来越重要。学习和使用这个前沿技术，不仅能提升自己与时俱进，还可以作为参与腾讯开源的一个切入点，为日后的工作打下坚实基础。”

![410178e43c2db2437b881d6c7935fc4e.png][]

![ddf97d260e6ec5f29376e0aa8f3d14e0.png][]

**APIJSON拓展资料**

**????APIJSON GitHub主页：**

https://github.com/Tencent/APIJSON

https://github.com/APIJSON/APIJSON-Demo

**???? APIJSON项目官网**

http://apijson.cn

**????文档**

http://7iscm.cn/j3IIx

**????演讲**

https://www.bilibili.com/video/BV1Tv411t74v?zw

https://www.bilibili.com/video/BV1yv411p7Y4

**????视频**

https://i.youku.com/i/UNTg1NzI1MjQ4MA==/videos?spm=a2hzp.8244740.0.0

![70ccbb29c14dae1ad13d0e6d474891d1.png][]

![c160333ce299d09f9e12a2f0e7c9d09c.png][]

**APIJSON实战任务**

（最终具体任务以实战阶段导师布置为准）

**编程任务**

**编程任务(任选一个)**  
**1.完善入门介绍视频**（清晰展示对应的操作步骤，从下载源码到跑起来项目完成接口测试，可参考宣传视频）  
https://lexiangla.com/teams/k100046/classes/a4eba9f4b6d711eba2ec268dd73d15f1?type=0&company\_from=79350bd4d06911ea91f05254002f1020

**2.接入 presto/hive/clickhouse/db2 任意一个**（能跑起来项目进行接口测试，起码简单的分页排序搜索等查询功能可用）  
https://github.com/Tencent/APIJSON\#%E8%A7%84%E5%88%92%E5%8F%8A%E8%B7%AF%E7%BA%BF%E5%9B%BE

**理论上所有支持 SQL 与 JDBC/ODBC 的软件，都可以用本项目对接 CRUD，待测试:**  
ClickHouse, Hive(延伸支持 Hadoop, Spark), DB2, Presto

**可依赖它们的 JDBC 驱动（jar/maven/gradle 方式都行）并在 DemoSQLConfig 中配置，参考以下步骤**  
https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-Java-Server

**及对应的 Demo（建议用最简单的初级上手 Demo 项目 APIJSONDemo）**  
https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONDemo/pom.xml

**贡献方式**  
**GitHub 上为 APIJSON 提交 Pull Request,具体见：**  
https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md

![91c74e1f5f27794d506e979f47c4c162.png][]

![479210e2dd67f49670eb01670a06e0a4.png][]

**问题答疑**

**1. 学习和使用 APIJSON 需要了解哪些相关的知识？**

需要了解 MySQL/PostgreSQL 或其它数据库的安装、建表、记录数据写入，Java IDE（InteliJ IDEA 或 Eclipse） 的安装，JDBC 驱动的接入（maven 或 jar 依赖）

https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONDemo/pom.xml

**2. 接入不同数据库时，是否需要修改相关源码？**

如果在业务项目（假设为 APIJSONDemo）则需要引入 maven/jar 依赖，并修改 DemoSQLConfig.java 的源码来配置数据库。

如果在 APIJSON 生成的 SQL 后出现不兼容该数据库 SQL 语法，则需要改 AbstractSQLConfig.java  的源码。

**3. APIJSON 源码需要掌握到什么程度？**

能够修改 APIJSONDemo 的源码，以及 APIJSON AbstractSQLConfig.java 关于 JSON 转 SQL 的过程，可以参考用户写的源码解析：

https://github.com/rainboy-learn/apijson-learn

例如对接 DB2 最主要的是部署数据库，接入对应的 JDBC 把它跑起来，可以使用最简单的 Demo 来修改

https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-Java-Server

AbstractSQLConfig.java 中 JSON 转 SQL 应该只需要把 分页 语法调整下就可以兼容低版本，可以参考有个开发者贡献的 Oracle 分页语法（修改了 getSQL 和 getLimitString，使用 ROWNUM 和子查询）

https://github.com/Tencent/APIJSON/pull/223/commits/08a3125adf96509ae8361095c18e54818e2e4711

AbstractSQLConfig.java 中 getQuote 为字段名引号，MySQL 用的是反引号 \`id\` , PostgreSQL/SQLServer/Oracle 都是双引号 "id"，

如果字段名和数据库关键词没有冲突，可以直接 return "";  即不使用引号，对于大部分数据库也都没问题。

![f0d3d7fed0a9d3d92c96a8fc16234cf8.png][]

**扫码填写问卷报名，提交项目proposal**

**加入开发实战**

**与导师一起成长这一夏**

![3b6bf839304426bb934b296d0e3d862b.png][]

APIJSON开源项目交流群

欢迎对本项目感兴趣的同学一起交流

![dc14fa28d56dace81edaed394f4d0794.png][]

更多开源项目信息，

尽在**“腾讯犀牛鸟开源人才社区”**

扫码加入，解锁所有学习资料

![0bd5ab57b58c9569247ca430ba289275.png][]

**关于腾讯犀牛鸟开源人才培养计划：**为响应国家十四五规划的开源战略，腾讯于2021年5月发布“首届腾讯犀牛鸟开源人才培养计划”，希望企业界和教育界形成合力，打造面向高校学生的开源课程和开源实践培养方案，培育开源人才，普及开源文化，助力开源人才生态的发展。

首届项目由教育部计算机教学指导委员会、教育部软件工程教学指导委员会、中国信息通信研究院作为联合指导单位，包括开源基础培训、开源进阶研学、开源项目实战三个环节，项目涉及云原生、微服务、容器、AI、大数据、前端、物联网/边缘计算等多项技术热点。

各位同学报名即可参加线上开源系列课程，学习开源知识，对话学界及产业界大咖。其中入选开源项目实战的学生将在导师的一对一指导下，利用暑假开展编程实战，并有机会获得腾讯开源贡献者证书（目前全球只发出了10+张）。

????学生指南Q&A：https://github.com/Tencent/OpenSourceTalent/issues/14

????官方QQ群：859260607 （加群请备注学校+专业）

**【其他项目介绍】**

[开源项目介绍 ｜TARS-高性能微服务治理框架][_TARS-]

[开源项目介绍｜Apache InLong-分布式消息中间件系统][Apache InLong-]

[开源项目介绍｜Tencent KonaJDK][Tencent KonaJDK]

[开源项目介绍 ｜SuperEdge-云原生边缘计算平台][_SuperEdge-]

[开源项目介绍 ｜Hippy-跨平台动态化框架][_Hippy-]

[开源项目介绍 ｜ Angel-高性能分布式机器学习平台][_ Angel-]

**腾讯犀牛鸟开源人才培养计划官网**

**https://opensource.tencent.com/summer-of-code**

（点击文末阅读原文直接访问）

合作或疑问欢迎联系：tencentopen@tencent.com

![532ed7921bde1526fc44402f456172c5.png][]

[58be94ce2d73070b42096002d8314145.gif]: /images/20221005/177650f11f314438817c480ce59e3e5e.png
[d03eb46cc4f9265940a542f5a6fe961d.png]: /images/20221005/8d4c0992f3d04deeb948fbc160dee5c7.png
[98830631bc19a2b6bfbf6a821177de3c.png]: /images/20221005/a7669f82401d467e979aa2e525b0744f.png
[1f03a3225fa12aabbf1b4f1896d01fe6.png]: /images/20221005/666b8eab4f0841f4a1ab4f43464561e4.png
[cee21f13a7f2c5b8387ab6a1c2c93376.png]: /images/20221005/c035d270d21c45138492199278a6a39a.png
[format_png]: /images/20221005/45876e01dd0b45ce898465b89f17d9b5.png
[410178e43c2db2437b881d6c7935fc4e.png]: /images/20221005/6dcb390571b24bfa8588e22d1e6e3954.png
[ddf97d260e6ec5f29376e0aa8f3d14e0.png]: /images/20221005/71c38e23d58b4d63a600dd8e18a402bc.png
[70ccbb29c14dae1ad13d0e6d474891d1.png]: /images/20221005/287b561459fb42338542f4fb06399407.png
[c160333ce299d09f9e12a2f0e7c9d09c.png]: /images/20221005/239faf157c484856a5d2bdb731f504aa.png
[91c74e1f5f27794d506e979f47c4c162.png]: /images/20221005/56ab1ae091eb4212b550be300634b61d.png
[479210e2dd67f49670eb01670a06e0a4.png]: /images/20221005/6f8ae5259c7c4cbaa2e61ac2b89775a6.png
[f0d3d7fed0a9d3d92c96a8fc16234cf8.png]: /images/20221005/77dda51551ca4f41bb739ec78f67e587.png
[3b6bf839304426bb934b296d0e3d862b.png]: /images/20221005/85a1680e8425412a9cc6e2b36d58b5fd.png
[dc14fa28d56dace81edaed394f4d0794.png]: /images/20221005/d46e7a12444c4086843f44eeb8289e7e.png
[0bd5ab57b58c9569247ca430ba289275.png]: /images/20221005/8e03c9a0ee194afc8809986571770804.png
[_TARS-]: http://mp.weixin.qq.com/s?__biz=MzIwMzYwMjkzOQ%3D%3D&chksm=96cda01ba1ba290dd8acc17bc91f6a1c084395326f78d428a14c727a0b1c99685451dfda5bc6&idx=1&mid=2247487119&scene=21&sn=25091eed2842493734be05f7dfd77d64#wechat_redirect
[Apache InLong-]: http://mp.weixin.qq.com/s?__biz=MzIwMzYwMjkzOQ%3D%3D&chksm=96cda019a1ba290fe43c45e5664e3ae589368bde050a63aa6ce6025e9800c78c0848e6895f95&idx=1&mid=2247487117&scene=21&sn=155dc3e9736912a404f6ba7501932c5d#wechat_redirect
[Tencent KonaJDK]: http://mp.weixin.qq.com/s?__biz=MzIwMzYwMjkzOQ%3D%3D&chksm=96cda0efa1ba29f96f263d6b0182ed0f987f20253191c8a8443671f5b8a99cb4b0d4b8f84d2e&idx=1&mid=2247487099&scene=21&sn=823f119f5c6822d67f944ce64ef4ada8#wechat_redirect
[_SuperEdge-]: http://mp.weixin.qq.com/s?__biz=MzIwMzYwMjkzOQ%3D%3D&chksm=96cda352a1ba2a446d994bc684fb6e70dc87f4ffe1ffe857be250b8b083da615796e29f72d08&idx=1&mid=2247486918&scene=21&sn=87cc487244f6d3a93b3493dee3ccff89#wechat_redirect
[_Hippy-]: http://mp.weixin.qq.com/s?__biz=MzIwMzYwMjkzOQ%3D%3D&chksm=96cda3f2a1ba2ae4fb62d00c2b7de33146a28e97ad974cb242a4862abb2504d103c7782b7124&idx=1&mid=2247486822&scene=21&sn=9fa6f5778c220de0c168d165b1a0d30d#wechat_redirect
[_ Angel-]: http://mp.weixin.qq.com/s?__biz=MzIwMzYwMjkzOQ%3D%3D&chksm=96cda233a1ba2b25ce2fb0a6cc2c2309797321f1fcb4feea3750a6427c799589333815fc6b0a&idx=1&mid=2247486631&scene=21&sn=15fa080953ee5406d8aa06a7727e9bcb#wechat_redirect
[532ed7921bde1526fc44402f456172c5.png]: /images/20221005/7d5a1197941b4f4ab35918f2e2c025c6.png