# apijson-ruoyi

**Repository Path**: laochen/apijson-ruoyi

## Basic Information

- **Project Name**: apijson-ruoyi
- **Description**: https://github.com/Tencent/APIJSON/issues/601
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2023-09-10
- **Last Updated**: 2023-09-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### Description

# **功能点**

-  apijson和若依框架整合
-  导入数据库表，生成apijson配置
-  页面模板，无需任何后台开发，即可使用
-  编辑表配置，生成apijson配置（在线初始化，增量和全量）
-  执行sql生成菜单
-  将模板生成前端页面拷贝进项目
-  管理员测试新增功能 增删改查
-  鉴权
    给普通用户分配查询权限
    测试是否存在越权
    给普通用户分配新增、修改、删除权限，测试功能是否正常
-  必传参数、字段类型、字段校验、前置后置函数等
-  json、sql、function 生成url
-  apijson底层 接口、数据库表操作鉴权
    已经将apijson和若依鉴权认证完全打通， 通过菜单配置权限即可。
-  数据操作人
    场景：比如订单， 用户只能查询自己拥有的订单， 管理员在后管可以查询所有的订单
-  假删除
    自动将删除语句替换为修改字段状态


# **功能使用说明**

## **使用数据库表模板，生成apijson配置**

### **代码生成**
<img width="823" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/47521b62-e7b8-41a8-b1b2-b9e8b6d744d4">

### **选择您要导入的数据库表**

<img width="804" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/04e9dcd7-f5e9-4d3c-a554-b1cc09c2b78c">

### **编辑表配置**
<img width="797" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/17297805-42d8-470c-8fca-2d8a5a5f2468">

<img width="800" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/14424264-013c-4007-a074-a002fa107543">
选择 页面存放菜单位置
<img width="815" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/e01bbafd-3b98-4c3e-a47b-b1d7bc0ee256">

### **生成apijson配置**
<img width="796" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/140616a9-f2ed-4345-898f-d76e1792f9b0">

### **执行sql语句，生成菜单**
<img width="739" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/c13b47d0-7995-4723-861c-ce6ed3ebac08">

### **拷贝前端页面**
<img width="749" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/7849cb5c-52de-4a69-ae90-deee9270e54c">

<img width="186" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/0247124d-dfc4-4624-8425-ba489e7c8d46">

### **管理员增删改查测试**
<img width="801" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/d46872cd-84fa-45d7-b4dc-3f1403cc47c8">

## **鉴权**
### **给普通用户分配查询权限**
测试普通用户是否能够插入数据
<img width="809" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/0d70d2c9-9324-4899-89cd-bcb470666288">
<img width="807" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/7ee570db-9b41-4d96-b076-a096240e77d7">
退出登录，切换普通用户
<img width="821" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/2a2f0189-2000-4cae-839d-befa43c86854">
普通用户只有查询权限
<img width="800" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/55c88a5e-fffa-4e35-af0f-7756bc5f4a56">
测试是否存在越权
postman 使用普通用户的token，模拟请求， 测试是否可以插入数据
http://localhost:8080/forms/api/gen/Post1692343037000
```json
{
    "postId": null,
    "postCode": "23",
    "postName": "23",
    "postSort": "23",
    "status": "0",
    "createBy": null,
    "createTime": null,
    "updateBy": null,
    "updateTime": null,
    "remark": "32"
}
```
<img width="888" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/90cfe152-7421-48e4-b420-6905872bec78">
apijson已经将鉴权和若依框架整合。
给普通用户分配新增、修改、删除权限
<img width="812" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/87ceacd0-090f-42f7-a8c2-a1ac0865ff1d">
<img width="816" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/261e5189-4d32-43bc-86ba-70b09ce4271d">

## **必传参数、字段类型、字段校验、前置后置函数等**
具体使用请参照apijson官网， 非常简单，配置即可。
可以在线配置，初始化生效，无需重启服务
<img width="813" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/3ff5e79b-84cc-4b7e-bc5d-00b290788b90">
必传参数
<img width="661" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/f9673f18-4319-4fd5-98d2-1c9a13ab4fc8">
前置后置函数（自定义校验方式）
<img width="653" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/cc8e5b17-0270-4762-ae70-939630cea937">
校验（可自己扩展）
<img width="811" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/7bc8d46e-806c-488e-8930-d0bcf6b72176">

## **json 生成url**
比如统计报表，多表关联查询等场景。
<img width="807" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/2ff82816-078d-4001-9c52-f179422d3114">
数据库表模板生成json， 后台也是同样的实现方式。
用postman进行功能测试， 也可以用官网的autoapi
<img width="808" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/97cb87c1-96be-4244-aa30-22070f9ed479">

## **sql 生成url**
用于复杂统计，不愿意用apijson实现。
<img width="807" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/6efd83b0-cda2-4651-a50e-cb84a166d7a3">
可以使用postman进行测试
后续如果有需要， json格式扩展实现@combine条件
## **Function 生成url**
function实现业务逻辑方法， 在线生成接口
新增远程函数
<img width="1085" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/ae8ef649-ccce-434a-85d6-f3a6310f4cf9">
在线生成接口
<img width="500" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/b2138750-f16b-400f-9e4b-672c822aed2f">
<img width="1092" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/d5b899eb-7d76-4bb2-b063-2aadb4077e46">
调用
<img width="1073" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/3f79d343-1234-4cea-8f34-ef7cbfa36b07">
<img width="1092" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/39fdf98e-58da-460f-80a1-a177597969cb">

代码添加鉴权
<img width="1034" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/1860b037-c1af-4842-84b8-458447d1e4cd">
如果想使用权限注解， 等我后面有空把若依注解扫描改造一下，目前若依 注解 只支持controller 方法。
添加按钮菜单权限
<img width="1090" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/acc99eb8-a37c-4e97-bf5a-4f97f71406b5">
给需要的角色分配按钮权限
<img width="1044" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/06a1a6ad-fe53-4687-abd5-a1e74bdad9e0">
Function 参数校验等
参照json生成url。
将function函数生成独立url。

接口、数据库表操作鉴权
已经将apijson和若依鉴权认证完全打通， 通过菜单配置权限即可。
apijson鉴权配置参见：
<img width="1103" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/93a39c5b-00ec-4f6b-9163-33d1711b05c0">

## **数据操作人**
配置 
<img width="1095" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/c4634b58-03c4-4a00-ab4a-4ca160f51466">
场景
比如订单， 用户只能查询自己拥有的订单， 管理员在后管可以查询所有的订单

```
{
    "id@-()": "getCurrentUserIdOrAdmin(id@-(),Ordermaster:rows[].Ordermaster.customerNo@)",
    "Ordermaster:rows[]": {
        "query": 2,
        "page": 0,
        "count": 10,
        "Ordermaster": {
            "customerNo@": "id",
            "@column": "orderNo:orderNo,customerNo:customerNo,salerNo:salerNo,orderDate:orderDate,orderSum:orderSum,invoiceNo:invoiceNo,",
            "@combine": "customerNo:1=1 & salerNo:1=1 & orderDate:1=1 & invoiceNo:1=1"
        }
    },
    "total@": "/Ordermaster:rows[]/total",
    "format": true,
    "@explain": true
}
```
经测试，完全能实现， 普通用户查询自己的数据，管理员查询所有数据
<img width="1082" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/33941f2a-26be-4f9b-8a9d-44169d1399d3">
## **假删除**
Access配置假删除的 deletedKey，deletedValue，notDeletedValue
框架会自动将delete语句转换为update，修改假删除字段的值。
<img width="998" alt="image" src="https://github.com/Tencent/APIJSON/assets/12228225/d709303e-c153-45d6-956c-3fe4be6a4617">