APIJSON（一：综述）

2021SC@SDUSC

APIJSON（一：综述）

1.相关定义解释
- （1）APIJSON
- （2）JSON
- （3）API
2.项目demo展示
- (1)首先到github上下载相关的文件
- (2)在数据库中导入相关文件
- (3)使用IDEA打开项目
- (4)测试连接
- (5)测试接口

1.相关定义解释

（1）APIJSON

“APIJSON 是一种专为 API 而生的 JSON 网络传输协议以及基于这套协议实现的 ORM 库。为简单的增删改查、复杂的查询、简单的事务操作提供了完全自动化的万能 API。”

上面这段话来自官方介绍，我们提取出其中的几个关键词加以解释——

（2）JSON

JSON(JavaScript Object Notation, JS 对象简谱) 是一种轻量级的数据交换格式。

划重点，一种轻量级的格式。（具体是什么格式其实这里不重要）

（3）API

API——Application Programming Interface，中文翻译为应用程序接口。

在我看来，API就像是一个信使，告诉系统你需要什么，然后将结果返回给你。

举一个现实生活中的例子：你在一家餐馆点菜，餐馆中的厨房会负责做菜（系统），现在缺少一个链接环节，将你的点菜单传给厨房，再把做好的菜端回餐桌。没错，做这项事的就是服务生（API)。服务生（API）讲你的订单（请求）交给厨房（系统），然后将菜（结果、反馈）端给你。

（在此推荐一个相关的视频）

在本例中，就是将请求用简单的json格式写好后，通过JSONAPI，转换成对应的sql语句将其传给数据库，就能返回我们想要的结果。

2.项目demo展示

(1)首先到github上下载相关的文件

可以直接使用git代码

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

(2)在数据库中导入相关文件

我在这里使用的是数据库可视化软件是SQLyog。

创建数据库->填写名称：apijson；选择基字符集：utf8；选择数据库排列规则：utf8_general_ci->右键该数据库；导入；执行SQL脚本；（相对路径为“APIJSON-Demo\MySQL\sys.sql”->刷新数据库，检查数据是否导入。

(3)使用IDEA打开项目

使用IDEA以Maven方式导入项目（相对路径为“APIJSON-Demo\APIJSON-Java-Server\APIJSONDemo”）

打开DemoSQLConfig进行数据库相关的配置——修改数据库名称为你刚刚创建的数据库名称，修改mysql版本；

`mysql -uroot -p`

修改数据库账号密码为你的账号密码。

之后运行DemoApplication

观察到下列提示后，证明可以成功运行。

(4)测试连接

打开浏览器输入网址

http://localhost:8080/get/{}

观察到框框中的代码则证明连接成功

(5)测试接口

http://apijson.cn/api/

点击发送请求，就会返回相应请求对应的数据

可以通过下列文档了解请求规则：

通用文档