APIJSON

2021SC@SDUSC

目录

关于APIJSON的介绍

API 特点

对于前端

接口工具

对于后端

功能说明

安装&使用

下载项目

               分析代码


关于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中查找你的包安装目录删除对应的包。 具体操作请自行百度。

 分析代码

分析关于Mysql 的增删改查部分

具体请看下一篇

APIJSON是一个为Java语言提供的RESTful API解决方案,它通过注解和配置的方式,简化了传统RESTful API的开发流程。APIJSON的核心特点之一就是能够方便地支持前端发送的JSON数据格式与后端Java对象之间的映射。 当你需要通过APIJSON框架实现远程函数传参时,通常需要遵循以下步骤: 1. 定义Java模型类:创建与数据库表相对应的Java模型类,并使用APIJSON提供的注解来标注模型类和字段,以便能够映射前端传入的JSON数据到这些模型类。 2. 实现API接口:编写相应的API接口类,使用APIJSON提供的注解来配置请求和响应的映射规则。 3. 配置方法传参:在API接口的方法中定义参数,这些参数将会由APIJSON框架自动从前端发送的JSON数据中解析并传递给方法。 4. 处理和返回数据:在API接口的方法中编写业务逻辑代码来处理这些参数,并将结果以JSON格式返回给前端。 例如,如果有一个API接口需要接收一个名为"username"的参数,并返回用户信息,你可以这样写: ```java // 定义用户模型类 public class User { private Long id; private String username; // 其他字段... } // 定义API接口 @API public class UserAPI { // 获取用户信息的方法,假设前端通过/api/user/info路径访问 @GET("/user/info") public Result getUserInfo(@Param("username") String username) { // 业务逻辑代码,根据用户名查询用户信息 User user = userService.findUserByUsername(username); // 将查询结果转换为JSON格式返回 return Result.success(user); } } ``` 在上述代码中,`@API`注解表明这是一个API接口类,`@GET`注解定义了一个GET请求的API,`@Param`注解用于从JSON请求体中提取参数。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值