学习自动化接口APIJSON

APIJSON是什么?

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

现已捐给腾讯进行管理。


APIJSON是基于JSON网络传输协议以及基于这套协议实现的ORM库。

APIJSON能做什么?

1.他做的事情:前端能够自己定义需要返回的数据结构。

使用APIJSON好处?

1.在简单的业务情景下,能够进行快速的开发。

2.后台只需要维护mode和表的映射就好了,不需要维护API接口文档和定义返回前端的数据接口,前端可以自己获取自己想要的数据类型。

3.减少了前后端的交通成本。

4.能够很好的兼容旧接口和新接口(客户端不再担心后台更改了数据结构,自己重构代码)

官网↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓

特点功能:

    在线解析:

        自动生成接口文档,清晰可读永远最新

        自动校验与格式化,支持高亮和收展

        自动生成各种语言代码,一键下载

        自动管理与测试接口用例,一键共享

        自动给请求JSON加注释,一键切换

        

    对于前端

        不用再向后端催接口、求文档

        数据和结构完全定制,要啥有啥

        看请求知结果,所求即所得

        可一次获取任何数据、任何结构

        能去除重复数据,节省流量提高速度



    对于后端

        提供通用接口,大部分API不用再写

        自动生成文档,不用再编写和维护

        自动校验权限、自动管理版本、自动防SQL注入

        开放API无需划分版本,始终保持兼容

        支持增删改查、模糊搜索、正则匹配、远程函数等


APIJSON弊端

1.APIJSON在复杂业务场景下,增加客户端的工作量。

2.控制的粒度不够细。


简单使用APIJSON

1.colne项目

https://gitee.com/Tencent/APIJSON.git

2.导入mysql表

mysql文件下的sql


3.修改数据库连接配置

DemoSQLConfig

1.数据库名 

2.数据库连接

3.数据库账号

4.密码


4.开启项目

DemoApplication


5.自定义接口

1.导入mysql

2.新建mode

3.如果表名和mode不一致需要映射

4.注册权限

request表中


访问

你可能感兴趣的:(学习自动化接口APIJSON)