2020-12-23 20:07:23 +08:00

21 KiB

Raw Blame History

Tencent is pleased to support the open source community by making APIJSON available.
Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved.
This source code is licensed under the Apache License Version 2.0

APIJSON

🏆 码云最有价值开源项目
🚀 后端接口和文档自动化，前端(客户端) 定制返回JSON的数据和结构！

English 通用文档视频教程在线体验

项目简介
上手使用
周边生态

APIJSON 是一种专为 API 而生的 JSON 网络传输协议以及基于这套协议实现的 ORM 库。
为简单的增删改查、复杂的查询、简单的事务操作提供了完全自动化的万能 API。
能大幅降低开发和沟通成本，简化开发流程，缩短开发周期。
适合中小型前后端分离的项目，尤其是 BaaS、Serverless、互联网创业项目和企业自用项目。

通过万能的 API，前端可以定制任何数据、任何结构！
大部分 HTTP 请求后端再也不用写接口了，更不用写文档了！
前端再也不用和后端沟通接口或文档问题了！再也不会被文档各种错误坑了！
后端再也不用为了兼容旧接口写新版接口和文档了！再也不会被前端随时随地没完没了地烦了！

特点功能

对于前端

不用再向后端催接口、求文档
数据和结构完全定制，要啥有啥
看请求知结果，所求即所得
可一次获取任何数据、任何结构
能去除重复数据，节省流量提高速度

对于后端

提供通用接口，大部分 API 不用再写
自动生成文档，不用再编写和维护
自动校验权限、自动管理版本、自动防 SQL 注入
开放 API 无需划分版本，始终保持兼容
支持增删改查、模糊搜索、正则匹配、远程函数等

APIJSON 接口展示

Postman 展示 APIJSON

APIAuto 展示 APIJSON

使用 APIAuto-机器学习接口工具来管理和测试 HTTP API 可大幅提升接口联调效率
(注意网页工具界面是 APIAuto，里面的 URL+JSON 才是 APIJSON 的 HTTP API)：

APIJSON 多表关联查询、结构自由组合，APIAuto 多个测试账号、一键共享测试用例

APIAuto 自动生成前端(客户端)请求代码和 Python 测试用例代码，一键下载

APIAuto 自动保存请求记录、自动生成接口文档，可添加常用请求、快捷查看一键恢复

APIAuto 一键自动接口回归测试，不需要写任何代码(注解、注释等全都不要)

一图胜千言 - APIJSON 部分基础功能概览

APIJSON App 演示

使用 APIJSON + ZBLibrary 开发的 Android 客户端 Demo (以下 Gif 图看起来比较卡，实际上运行很流畅)：

为什么选择 APIJSON？

前后端关于接口的开发、文档、联调等 10 大痛点解析
https://github.com/Tencent/APIJSON/wiki

解决十大痛点 (APIJSON 大幅提振开发效率、强力杜绝联调扯皮、巧妙规避文档缺陷、非常节省流量带宽等)
开发提速巨大 (CRUD 零代码热更新自动化，APIJSONBoot 对比 SSM、SSH 等保守估计可提速 20 倍以上)
腾讯官方开源 (使用 GitHub、Gitee、工蜂等平台的官方账号开源，微信公众号、腾讯云+社区等官方公告)
社区影响力大 (GitHub 9.3K Star 在 350W Java 项目中排名前 200，远超 FLAG, BAT 等国内外绝大部分开源项目)
各项荣誉成就 (腾讯开源五个第一、腾讯首个 GVP 获奖项目、腾讯后端项目 Star 第一、GitHub Java 周榜第一等)
多样用户案例 (腾讯内部用户包含互娱、音乐、云与智慧，外部用户包含 500 强上市公司、数千亿资本国企等)
适用场景广泛 (社交聊天、阅读资讯、影音视频、办公学习等各种 App、网站、公众号、小程序等非金融类项目)
周边生态丰富 (Android, iOS, Web 等各种 Demo、继承 JSON 的海量生态、零代码接口测试和单元测试工具等)
文档视频齐全 (项目介绍、快速上手、安装部署等后端、前端、客户端的图文解说、视频教程、代码注释等)
功能丰富强大 (增删改查、分页排序、分组聚合、各种 JOIN、各种子查询、跨库跨表、性能分析等零代码实现)
使用安全简单 (自动增删改查、自动生成文档、自动管理版本、自动控制权限、自动校验参数、自动防SQL注入等)
灵活定制业务 (在后端编写远程函数，可以拿到 session、version、当前 JSON 对象等，然后自定义处理)
高质可靠代码 (代码工整规范、商业分析软件源伞 Pinpoint 代码扫描报告平均每行代码 bug 率低至 0.15%)
兼容各种项目 (对各类 Web 框架集成友好且提供 SpringBoot, JFinal 的 Demo，协议不限 HTTP，与其它库无冲突)
工程轻量小巧 (仅依赖 fastjson，Jar 仅 280KB，Java 文件仅 59 个共 13719 行代码，例如 APIJSONORM 4.3.1)
多年持续迭代 (自 2016 年开源至今已连续 4 年 2000+ Commits、70+ Releases，不断更新迭代中...)

常见问题

1.如何定制业务逻辑？

在后端编写远程函数，可以拿到 session、version、当前 JSON 对象、参数名称等，然后对查到的数据自定义处理
https://github.com/Tencent/APIJSON/issues/101

2.如何控制权限？

在 Access 表配置校验规则，默认不允许访问，需要对每张表、每种角色、每种操作做相应的配置，粒度细分到行级
https://github.com/Tencent/APIJSON/issues/12

3.如何校验参数？

在 Request 表配置校验规则 structure，提供 MUST、TYPE、VERIFY 等通用方法，可通过远程函数来完全自定义
https://github.com/Tencent/APIJSON/wiki#%E5%AE%9E%E7%8E%B0%E5%8E%9F%E7%90%86

其它问题见 Closed Issues
https://github.com/Tencent/APIJSON/issues?q=is%3Aissue+is%3Aclosed

快速上手

1.后端上手

可以跳过这个步骤，直接用APIJSON服务器IP地址 apijson.cn:8080 来测试接口。
见 APIJSON后端上手 - Java

2.前端上手

可以跳过这个步骤，直接使用 APIAuto-机器学习HTTP接口工具或下载客户端App。
见 Android 或 iOS 或 JavaScript

下载客户端 App

仿微信朋友圈动态实战项目
APIJSONApp.apk

测试及自动生成代码工具
APIJSONTest.apk

使用登记

更多 APIJSON 使用者

贡献者们

主项目 APIJSON 的贡献者们和生态周边项目的作者们：

感谢大家的贡献。

规划及路线图

新增功能、强化安全、提高性能、增强稳定、完善文档、丰富周边、推广使用
https://github.com/Tencent/APIJSON/blob/master/Roadmap.md

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

我要赞赏

如果你喜欢 APIJSON，感觉 APIJSON 帮助到了你，可以点右上角 ⭐Star 支持一下，谢谢 ^_^

技术交流

如果有什么问题或建议可以提ISSUE 或加群，交流技术，分享经验。
如果你解决了某些bug，或者新增了一些功能，欢迎贡献代码，感激不尽~
https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md

QQ 技术群： 734652054（新）、607020115（旧）

生态项目

APIJSON-Demo APIJSON 各种语言、各种框架的使用示例项目、上手文档、测试数据 SQL 文件等

apijson-orm APIJSON ORM 库，可通过 Maven, Gradle 等远程依赖

apijson-framework APIJSON 服务端框架，可通过 Maven, Gradle 等远程依赖

APIAuto 敏捷开发最强大易用的 HTTP 接口工具，机器学习零代码测试、生成代码与静态检查、生成文档与光标悬浮注释

UnitAuto 机器学习单元测试平台，零代码、全方位、自动化测试方法/函数的正确性和可用性

apijson-doc APIJSON 官方文档，提供排版清晰、搜索方便的文档内容展示，包括设计规范、图文教程等

APIJSONdocs APIJSON 英文文档，提供排版清晰的文档内容展示，包括详细介绍、设计规范、使用方式等

apijson.org APIJSON 官方网站，提供 APIJSON 的功能简介、登记用户、作者与贡献者、相关链接等

APIJSON.NET C# 版 APIJSON ，支持 MySQL, PostgreSQL, SQL Server, Oracle, SQLite

apijson-php PHP 版 APIJSON，基于 ThinkPHP，支持 MySQL, PostgreSQL, SQL Server, Oracle 等

apijson-node Node.ts 版 APIJSON，提供 nestjs 和 typeorm 的 Demo，支持 MySQL, PostgreSQL, SQL Server, Oracle

uliweb-apijson Python 版 APIJSON，支持 MySQL, PostgreSQL, SQL Server, Oracle, SQLite 等

APIJSONParser 第三方 APIJSON 解析器，将 JSON 动态解析成 SQL

ApiJsonByJFinal 整合 APIJSON 和 JFinal 的 Demo

SpringServer1.2-APIJSON 智慧党建服务器端，提供上传和下载文件的接口

apijson-builder 一个方便为 APIJSON 构建 RESTful 请求的 JavaScript 库

AbsGrade 列表级联算法，支持微信朋友圈单层评论、QQ空间双层评论、百度网盘多层(无限层)文件夹等

APIJSON-Android-RxJava 仿微信朋友圈动态实战项目，ZBLibrary(UI) + APIJSON(HTTP) + RxJava(Data)

Android-ZBLibrary Android MVP快速开发框架，Demo全面，注释详细，使用简单，代码严谨

感谢热心的作者们的贡献，点 ⭐Star 支持下他们吧。

21 KiB Raw Blame History Unescape Escape