APIJSON 开源项目教程

1. 项目介绍

APIJSON 是一个由腾讯开发的零代码、全功能、强安全的 ORM（对象关系映射）库。它旨在通过提供万能通用接口，大幅降低开发和沟通成本，简化开发流程，缩短开发周期。APIJSON 特别适合中小型前后端分离的项目，尤其是创业项目、内部项目、低代码/零代码、小程序、BaaS、Serverless 等场景。

主要特点：

• 零代码接口和文档：后端接口和文档零代码，前端可以定制返回 JSON 的数据和结构。
• 自动生成文档：自动生成和维护 API 文档，减少手动编写和维护的工作量。
• 强安全：自动校验权限、自动管理版本、自动防 SQL 注入。
• 灵活定制：前端可以定制任何数据、任何结构，后端提供远程函数支持自定义业务逻辑。

2. 项目快速启动

2.1 后端快速启动

2.1.1 环境准备

• Java 8 或更高版本
• Maven 3.x
• MySQL 5.7 或更高版本

2.1.2 项目克隆

git clone https://github.com/Tencent/APIJSON.git
cd APIJSON

2.1.3 配置数据库

在 src/main/resources/application.yml 中配置数据库连接信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/your_database_name
    username: your_username
    password: your_password

2.1.4 启动项目

mvn spring-boot:run

2.2 前端快速启动

2.2.1 环境准备

• Node.js 12 或更高版本
• npm 或 yarn

2.2.2 安装依赖

npm install

2.2.3 启动前端应用

npm start

3. 应用案例和最佳实践

3.1 腾讯内部项目

腾讯内部多个项目使用了 APIJSON，如互娱、音乐、微信、云与智慧等。APIJSON 帮助这些项目大幅降低了开发成本，提升了开发效率。

3.2 华为项目

华为在某些内部项目中采用了 APIJSON，通过其强大的 ORM 功能和自动生成文档的特性，简化了接口开发和文档维护。

3.3 最佳实践

• 权限控制：通过 Access 表配置校验规则，实现细粒度的权限控制。
• 参数校验：在 Request 表配置校验规则 structure，提供 MUST、TYPE、VERIFY 等通用方法，确保数据安全。
• 远程函数：在后端编写远程函数，自定义处理业务逻辑，灵活应对各种需求。

4. 典型生态项目

4.1 APIJSON-ORM

APIJSON-ORM 是 APIJSON 的核心库，提供了零代码的增删改查、跨库连表、JOIN 嵌套子查询等功能。

4.2 APIAuto

APIAuto 是一个机器学习接口工具，用于管理和测试 HTTP API。它支持自动生成前端请求代码和 Python 测试用例代码，大幅提升开发效率。

4.3 APIJSONApp

APIJSONApp 是一个使用 APIJSON + ZBLibrary 开发的 Android 客户端 Demo，展示了 APIJSON 在实际项目中的应用。

通过以上教程，您可以快速上手 APIJSON，并了解其在实际项目中的应用和最佳实践。希望 APIJSON 能帮助您简化开发流程，提升开发效率。