APIJSON

最新推荐文章于 2025-06-02 09:02:23 发布

原创最新推荐文章于 2025-06-02 09:02:23 发布 · 4.1k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#java

本文介绍了APIJSON，一种用于自动化API开发的框架，它简化了前后端交互，减少文档编写和维护成本。通过自动生成接口和文档，以及支持数据定制，提升开发效率并适用于各类项目如小程序、BaaS和Serverless。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

2021SC@SDUSC

关于APIJSON的介绍

APIJSON 是一种专为 API 而生的 JSON 网络传输协议以及基于这套协议实现的 ORM 库。
为各种增删改查提供了完全自动化的万能 API，零代码实时满足千变万化的各种新增和变更需求。
能大幅降低开发和沟通成本，简化开发流程，缩短开发周期。
适合中小型前后端分离的项目，尤其是初创项目、内部项目、低代码/零代码、小程序、BaaS、Serverless 等。

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

API 特点

对于前端

不用再向后端开发同事催接口、求文档前端能完全定制数据和结构，要啥有啥,

调用接口看请求知结果，所求即所得。可以一次性获取任何数据、任何结构。能够去除重复数据，节省流量提高速度

接口工具

自动生成接口文档，清晰可读永远最新。自动校验与格式化，支持高亮和收展。自动生成各种语言的代码，一键下载。自动管理与测试接口用例，一键共享。自动给请求JSON加上注释，一键切换

对于后端

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

功能说明

一个接口的开发，比如Java用SpringBoot，Mybatis来开发一般来说就像下面这个流程

1545468341131

部署上这个项目后，流程变成了这样

1545468361962

如果使用 apijson-framework，还可进一步简化流程

1543975563776

换句话说，使用这个项目作为后端的支持的话，是不需要对每个表写增删改查等接口的，只需在该项目连接的数据里进行表的创建，以及配置接口权限即可。无需进行过多的开发，哪怕是要改结构也仅仅只需要修改表字段而已。想想仅仅是部署一个后端项目，现在需要些的接口就基本写好了，直接调用就行了，是不是挺爽的。

说这么多，咱们直接开干吧！

B.安装&使用

JDK： 1.8+

Maven： 3.0+

数据库：Mysql，Oralce

B1.下载项目

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

或者，直接下载ZIP打包好的项目文件。

eclipse导入：

顶部菜单File > Import > Maven > Existing Maven Projects > Next > Browse

APIJSON-Demo-Master/APIJSON-Java-Server/APIJSONDemo

报依赖错误的时候，同目录下的lib里面的jar添加到Build Path中。

1542345887787

为了方便修改源代码，你可以像我一样不添加libs/apijson-orm.jar文件到Build Path中。而是libs/apijson-orm.jar的源码，复制到当前项目里。

源代码在
APIJSON/APIJSONORM at master · Tencent/APIJSON · GitHub

有可能这时候pom.xml中报错，例如：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

这段代码中的这一句：

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

提示错误。其实是maven中安装包的问题。那么在Window->Preference->Maven->User Settings中查找你的包安装目录删除对应的包。具体操作请自行百度。