︻腾讯犀牛鸟开源人才培养计划︼开始啦！加入我们开源共建吧~
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
🚀 后端接口和文档零代码，前端(客户端) 定制返回 JSON 的数据和结构
English
通用文档
视频教程
在线体验
导航目录‥ 项目简介 上手使用 社区生态 完整详细的导航目录 点这里查看
APIJSON 是一种专为 API 而生的 JSON 网络传输协议 以及 基于这套协议实现的 ORM 库。
为 简单的增删改查、复杂的查询、简单的事务操作 提供了完全自动化的万能 API。
能大幅降低开发和沟通成本，简化开发流程，缩短开发周期。
适合中小型前后端分离的项目，尤其是 BaaS、Serverless、互联网创业项目和企业自用项目。
通过万能的 API，前端可以定制任何数据、任何结构。
大部分 HTTP 请求后端再也不用写接口了，更不用写文档了。
前端再也不用和后端沟通接口或文档问题了。再也不会被文档各种错误坑了。
后端再也不用为了兼容旧接口写新版接口和文档了。再也不会被前端随时随地没完没了地烦了。
APIAuto 自动生成前端(客户端)请求代码 和 Python 测试用例代码，一键下载
APIAuto 自动保存请求记录、自动生成接口文档，可添加常用请求、快捷查看一键恢复
APIAuto 一键自动接口回归测试，不需要写任何代码(注解、注释等全都不要)
一图胜千言 - APIJSON 部分基础功能概览
还有为 APIJSON 扫描代码贡献 Issue 的 奇安信代码卫士 和 源伞科技
感谢大家的贡献。
⭐ Star 支持一下，谢谢 ^_^
导航目录‥ 项目简介 上手使用 社区生态 完整详细的导航目录 点这里查看
⭐ Star 支持下他们吧。
APIJSON
零代码、热更新、自动化 ORM 库
English
通用文档
视频教程
在线体验
特点功能
对于前端
●不用再向后端催接口、求文档 ●数据和结构完全定制，要啥有啥 ●看请求知结果，所求即所得 ●可一次获取任何数据、任何结构 ●能去除重复数据，节省流量提高速度对于后端
●提供通用接口，大部分 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 分享演讲
APIJSON-零代码接口与文档 ORM 库︵国际开源谷 Gitee Meetup︶
https://www.bilibili.com/video/BV1Tv411t74v
APIJSON 和 APIAuto-零代码开发和测试︵QECon 全球软件质量&效能大会︶
https://www.bilibili.com/video/BV1yv411p7Y4
为什么选择 APIJSON？
前后端 关于接口的 开发、文档、联调 等10个痛点解析 https://github.com/Tencent/APIJSON/wiki ●解决十个痛点 (APIJSON 可帮助用户 提振开发效率、杜绝联调扯皮、规避文档缺陷、节省流量带宽 等) ●开发提速很大 (CRUD 零代码热更新自动化，APIJSONBoot 对比 SSM、SSH 等保守估计可提速20倍以上) ●腾讯官方开源 (使用 GitHub、Gitee、工蜂 等平台的官方账号开源，微信公众号、腾讯云+社区 等官方公告) ●社区影响力大 (GitHub 1W+ Star 在 350W Java 项目中排名前 140，远超 FLAG, BAT 等国内外绝大部分开源项目) ●多样用户案例 (腾讯内部用户包含 互娱、音乐、云与智慧，外部用户包含 500 强上市公司、数千亿资本国企 等) ●适用场景广泛 (社交聊天、阅读资讯、影音视频、办公学习 等各种 App、网站、公众号、小程序 等非金融类项目) ●周边生态丰富 (Android, iOS, Web 等各种 Demo、继承 JSON 的海量生态、零代码 接口测试 和 单元测试 工具等) ●文档视频齐全 (项目介绍、快速上手、安装部署 等后端、前端、客户端的 图文解说、视频教程、代码注释 等) ●功能丰富强大 (增删改查、分页排序、分组聚合、各种 JOIN、各种子查询、跨库跨表、性能分析 等零代码实现) ●使用安全简单 (自动增删改查、自动生成文档、自动管理版本、自动控制权限、自动校验参数、自动防SQL注入等) ●灵活定制业务 (在后端编写 远程函数，可以拿到 session、version、当前 JSON 对象 等，然后自定义处理) ●高质可靠代码 (代码严谨规范，商业分析软件源伞 Pinpoint 代码扫描报告平均每行代码 Bug 率低至 0.15%) ●兼容各种项目 (协议不限 HTTP，与其它库无冲突，对各类 Web 框架集成友好且提供 SpringBoot, JFinal 的 Demo) ●工程轻量小巧 (仅依赖 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/1012.如何控制权限？
在 Access 表配置校验规则，默认不允许访问，需要对 每张表、每种角色、每种操作 做相应的配置，粒度细分到行级 https://github.com/Tencent/APIJSON/issues/123.如何校验参数？
在 Request 表配置校验规则 structure，提供 MUST、TYPE、VERIFY 等通用方法，可通过 远程函数 来完全自定义 https://github.com/Tencent/APIJSON/wiki#%E5%AE%9E%E7%8E%B0%E5%8E%9F%E7%90%86 更多常见问题及提问前必看 https://github.com/Tencent/APIJSON/issues/36注意事项
请求参数 JSON 中表名、字段名、关键词及对应的值都是大小写敏感、逗号敏感、分号敏感、空格敏感、换行敏感， 大部分情况都不允许空格和换行，表名以大写字母开头，不要想当然，请严格按照 设计规范 来调用 API #181 导航目录‥ 项目简介 上手使用 社区生态 完整详细的导航目录 点这里查看快速上手
1.后端上手
可以跳过这个步骤，直接用APIJSON服务器IP地址 apijson.cn:8080 来测试接口。 见 APIJSON后端上手 - Java2.前端上手
可以跳过这个步骤，直接使用 APIAuto-机器学习HTTP接口工具 或 下载客户端App。 见 Android 或 iOS 或 JavaScript下载客户端 App
仿微信朋友圈动态实战项目 APIJSONApp.apk 测试及自动生成代码工具 APIJSONTest.apk开源许可
使用 Apache License 2.0，对 公司、团队、个人 等 商用、非商用 都自由免费且非常友好，请放心使用和登记使用登记
如果您在使用 APIJSON，请让我们知道，您的使用对我们非常重要(按登记顺序排列)‥ https://github.com/Tencent/APIJSON/issues/187
贡献者们
主项目 APIJSON 的贡献者们和 生态周边项目 的作者们‥
还有为 APIJSON 扫描代码贡献 Issue 的 奇安信代码卫士 和 源伞科技
感谢大家的贡献。
