hero

APIJSON 文档

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

快速开始 →

在线解析

自动生成接口文档,清晰可读永远最新。自动生成请求代码,支持Android和iOS。自动生成JavaBean文件,一键下载。自动管理与测试接口用例,一键共享。自动校验与格式化JSON,支持高亮和收展。

对于前端

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

对于后端

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

# 开源许可

使用 Apache License 2.0,对 公司、团队、个人 等 商用、非商用 都自由免费且非常友好,请放心使用和登记

# 使用登记

如果您在使用 APIJSON,请让我们知道,您的使用对我们非常重要(按登记顺序排列):
https://github.com/Tencent/APIJSON/issues/187


# 贡献者们

主项目 APIJSON 的贡献者们(5 个腾讯工程师、1 个知乎基础研发架构师 等):
https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md


生态周边项目的作者们(1 个腾讯工程师、1 个字节跳动工程师 等):
https://github.com/search?o=desc&q=apijson&s=stars&type=Repositories
https://search.gitee.com/?skin=rec&type=repository&q=apijson&sort=stars_count


还有为 APIJSON 扫描代码贡献 Issue 的 奇安信代码卫士 (opens new window)源伞科技 (opens new window)

感谢大家的贡献。

# 规划及路线图

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

理论上所有支持 SQL 与 JDBC/ODBC 的软件,都可以用本项目对接 CRUD,待测试:
DB2 (opens new window), Elasticsearch (opens new window), ClickHouse (opens new window), OceanBase (opens new window), Presto (opens new window), Spark (opens new window), Hive (opens new window)(延伸支持 Hadoop, Spark), Phoenix (opens new window)(延伸支持 HBase), Presto/Trino (opens new window)(延伸支持 Redis, Hive, Kafka, Elasticsearch, Thrift, Cassandra, MySQL, PostgreSQL, Oracle, MongoDB...) ß

# 技术交流

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

QQ 技术群: 734652054(新)、607020115(旧)

如果你为 APIJSON 做出了以下任何一个贡献:
提交了 PR 且被合并 (opens new window)提交了优质 Issue (opens new window)发表了优质文章 (opens new window)开发了可用的生态项目 (opens new window)登记了你的公司 (opens new window),可以加
贡献者微信群,注意联系 LonelyExplorer,加好友描述中附上贡献链接,谢谢