229 lines
6.9 KiB
Markdown
229 lines
6.9 KiB
Markdown
# 28个示例接口详细说明
|
|
|
|
## SQL操作类 (15条)
|
|
|
|
### 1. 当前用户
|
|
- **ID**: `83ae1f5e5c26447b8c4849ead352b048`
|
|
- **类型**: SQL查询
|
|
- **SQL**:
|
|
```sql
|
|
SELECT f_real_name, f_organize_id
|
|
FROM base_user
|
|
WHERE f_id = {@userId}
|
|
```
|
|
- **用途**: 获取当前登录用户的基本信息
|
|
|
|
### 2. 查询当前组织
|
|
- **ID**: `a0c3186292df4fe2842f66dee0ea7729`
|
|
- **类型**: SQL查询
|
|
- **SQL**: 多表JOIN查询用户及其组织信息
|
|
- **用途**: 获取用户所属组织详情
|
|
|
|
### 3. 查询当前组织以及子组织
|
|
- **ID**: `fdfd02c7628a4ea4a0b125463e7933e0`
|
|
- **类型**: SQL查询
|
|
- **用途**: 获取当前组织及所有子组织
|
|
|
|
### 4. 用户列表
|
|
- **ID**: `ebcc44be142e43b795c0d769abd6d25a`
|
|
- **类型**: SQL查询
|
|
- **SQL**: 多表JOIN查询用户、岗位、组织信息
|
|
- **用途**: 用户管理下拉列表
|
|
|
|
### 5. 查询当前用户以及下属
|
|
- **ID**: `bd993fb8dc914076a3848b0c121b17ca`
|
|
- **类型**: SQL查询
|
|
- **用途**: 获取当前用户及所有下属用户
|
|
|
|
### 6. 视图表数据
|
|
- **ID**: `395176542063304069`
|
|
- **类型**: SQL查询
|
|
- **SQL**: 视图查询,包含多字段
|
|
- **用途**: 从视图获取数据
|
|
|
|
### 7. 列表树形表格
|
|
- **ID**: `395178064327220613`
|
|
- **类型**: SQL查询
|
|
- **SQL**: `SELECT F_Id, pid as F_PId, nametest as F_FullName`
|
|
- **用途**: 树形表格数据
|
|
|
|
### 8. 菜单
|
|
- **ID**: `398809921702874629`
|
|
- **类型**: SQL查询
|
|
- **SQL**: `SELECT * FROM base_module`
|
|
- **用途**: 系统菜单查询
|
|
|
|
### 9. 测试
|
|
- **ID**: `400305221865071237`
|
|
- **类型**: SQL查询
|
|
- **参数**: organize
|
|
- **SQL**: 多表JOIN带参数
|
|
- **用途**: 测试用接口
|
|
|
|
### 10. 行政区划
|
|
- **ID**: `420587863533428357`
|
|
- **类型**: SQL查询
|
|
- **参数**: parentId
|
|
- **SQL**: `SELECT f_id, f_full_name FROM base_province WHERE f_parent_id = {parentId}`
|
|
- **用途**: 省市区三级联动
|
|
|
|
### 11. SQL真分页
|
|
- **ID**: `469125798494792965`
|
|
- **类型**: SQL查询
|
|
- **分页**: hasPage=1
|
|
- **SQL**:
|
|
```sql
|
|
SELECT * FROM base_user
|
|
WHERE f_real_name LIKE CONCAT('%', @keyword, '%')
|
|
LIMIT @offsetSize, @pageSize
|
|
```
|
|
- **用途**: 带分页的用户查询
|
|
|
|
### 12. 树形sql_字段列表
|
|
- **ID**: `469492643924081285`
|
|
- **类型**: SQL查询
|
|
- **SQL**: `SELECT F_Id, F_Full_Name, F_Parent_Id as F_PId FROM base_dictionary_type`
|
|
- **用途**: 字典类型树形数据
|
|
|
|
### 13. 下拉多参_字段列表
|
|
- **ID**: `469493539378625157`
|
|
- **类型**: SQL查询
|
|
- **参数**: name, gender
|
|
- **SQL**: 多条件模糊查询
|
|
- **用途**: 下拉选择器数据
|
|
|
|
### 14. 区域下拉补全_字段列表
|
|
- **ID**: `469493805800815237`
|
|
- **类型**: SQL查询
|
|
- **参数**: name
|
|
- **SQL**: `SELECT f_id, f_full_name FROM base_province_atlas`
|
|
- **用途**: 区域联想输入
|
|
|
|
### 15. 当前组织_字段列表
|
|
- **ID**: `469500704067746437`
|
|
- **类型**: SQL查询
|
|
- **SQL**: 多表JOIN查询组织信息
|
|
- **用途**: 组织选择器数据
|
|
|
|
---
|
|
|
|
## 静态数据类 (8条)
|
|
|
|
### 16. 柱状图
|
|
- **ID**: `cd6fe911f90048f0bba7ef9f38251d96`
|
|
- **类型**: 静态数据
|
|
- **用途**: ECharts柱状图配置
|
|
|
|
### 17. 折线图
|
|
- **ID**: `be312b18a1664d8787e0dfcd2412969f`
|
|
- **类型**: 静态数据
|
|
- **用途**: ECharts折线图配置
|
|
|
|
### 18. 饼图
|
|
- **ID**: `79e5455c2f0d4d8ba2b444249bae0490`
|
|
- **类型**: 静态数据
|
|
- **用途**: ECharts饼图配置
|
|
|
|
### 19. 象形图
|
|
- **ID**: `8ce8ccf7a3bf48a79a0c2bff20b46726`
|
|
- **类型**: 静态数据
|
|
- **用途**: ECharts象形图配置
|
|
|
|
### 20. 雷达图
|
|
- **ID**: `78814d0a32fa41ae8427b708bfadb808`
|
|
- **类型**: 静态数据
|
|
- **用途**: ECharts雷达图配置
|
|
|
|
### 21. 散点图
|
|
- **ID**: `04d910fb47f4469e907a5c85949329cb`
|
|
- **类型**: 静态数据
|
|
- **用途**: ECharts散点图配置
|
|
|
|
### 22. 漏斗图
|
|
- **ID**: `3044325436d347af9b59a617f10e3ab6`
|
|
- **类型**: 静态数据
|
|
- **用途**: ECharts漏斗图配置
|
|
|
|
### 23. 测试级联_字段列表
|
|
- **ID**: `469493919109937797`
|
|
- **类型**: 静态数据
|
|
- **数据**: 级联选择JSON结构
|
|
- **用途**: 级联选择器数据
|
|
|
|
---
|
|
|
|
## API操作类 (5条)
|
|
|
|
### 24. 获取订单商品接口
|
|
- **ID**: `360711881444294853`
|
|
- **类型**: API
|
|
- **Method**: GET
|
|
- **URL**: `/api/extend/CrmOrder/Goods`
|
|
- **参数**: keyword
|
|
- **用途**: 调用外部订单商品API
|
|
|
|
### 25. 访问jnpf接口认证示例
|
|
- **ID**: `395538362724780101`
|
|
- **类型**: API
|
|
- **Method**: GET
|
|
- **URL**: `/api/system/DataInterface/.../Actions/Response`
|
|
- **用途**: 内部API调用示例
|
|
|
|
### 26. 系统菜单接口(示例)
|
|
- **ID**: `398826053293854213`
|
|
- **类型**: API
|
|
- **Method**: GET
|
|
- **URL**: `/api/system/System`
|
|
- **参数**: 8个(id, fullName, enCode等)
|
|
- **用途**: 系统菜单API
|
|
|
|
### 27. API真分页
|
|
- **ID**: `469125039078305029`
|
|
- **类型**: API
|
|
- **分页**: hasPage=1
|
|
- **URL**: `/api/system/DataInterface?sort=desc`
|
|
- **用途**: API分页查询
|
|
|
|
### 28. 添加公告接口
|
|
- **ID**: `469471490920740869`
|
|
- **类型**: API
|
|
- **Method**: POST
|
|
- **URL**: `/api/message/Notice`
|
|
- **参数**: text, body, excerpt
|
|
- **用途**: POST提交数据
|
|
|
|
---
|
|
|
|
## 快速参考表
|
|
|
|
| # | ID | 名称 | 类型 | 关键特征 |
|
|
|---|-----|------|------|----------|
|
|
| 1 | 83ae1f5e5c26447b8c4849ead352b048 | 当前用户 | SQL | {@userId} |
|
|
| 2 | a0c3186292df4fe2842f66dee0ea7729 | 查询当前组织 | SQL | 多表JOIN |
|
|
| 3 | fdfd02c7628a4ea4a0b125463e7933e0 | 查询当前组织以及子组织 | SQL | 组织树 |
|
|
| 4 | ebcc44be142e43b795c0d769abd6d25a | 用户列表 | SQL | 多表JOIN |
|
|
| 5 | cd6fe911f90048f0bba7ef9f38251d96 | 柱状图 | 静态 | 图表 |
|
|
| 6 | be312b18a1664d8787e0dfcd2412969f | 折线图 | 静态 | 图表 |
|
|
| 7 | 79e5455c2f0d4d8ba2b444249bae0490 | 饼图 | 静态 | 图表 |
|
|
| 8 | 8ce8ccf7a3bf48a79a0c2bff20b46726 | 象形图 | 静态 | 图表 |
|
|
| 9 | 78814d0a32fa41ae8427b708bfadb808 | 雷达图 | 静态 | 图表 |
|
|
| 10 | 04d910fb47f4469e907a5c85949329cb | 散点图 | 静态 | 图表 |
|
|
| 11 | 3044325436d347af9b59a617f10e3ab6 | 漏斗图 | 静态 | 图表 |
|
|
| 12 | bd993fb8dc914076a3848b0c121b17ca | 查询当前用户以及下属 | SQL | {@userId} |
|
|
| 13 | 360711881444294853 | 获取订单商品接口 | API | GET |
|
|
| 14 | 395176542063304069 | 视图表数据 | SQL | 视图 |
|
|
| 15 | 395178064327220613 | 列表树形表格 | SQL | 树形 |
|
|
| 16 | 395538362724780101 | 访问jnpf接口认证示例 | API | 鉴权 |
|
|
| 17 | 398809921702874629 | 菜单 | SQL | base_module |
|
|
| 18 | 398826053293854213 | 系统菜单接口(示例) | API | 多参数 |
|
|
| 19 | 400305221865071237 | 测试 | SQL | 带参数 |
|
|
| 20 | 420587863533428357 | 行政区划 | SQL | {parentId} |
|
|
| 21 | 469125039078305029 | API真分页 | API | hasPage=1 |
|
|
| 22 | 469125798494792965 | SQL真分页 | SQL | hasPage=1 |
|
|
| 23 | 469471490920740869 | 添加公告接口 | API | POST |
|
|
| 24 | 469492643924081285 | 树形sql_字段列表 | SQL | 树形 |
|
|
| 25 | 469493539378625157 | 下拉多参_字段列表 | SQL | 多参数 |
|
|
| 26 | 469493805800815237 | 区域下拉补全_字段列表 | SQL | 联想 |
|
|
| 27 | 469493919109937797 | 测试级联_字段列表 | 静态 | 级联 |
|
|
| 28 | 469500704067746437 | 当前组织_字段列表 | SQL | {@organizeId} |
|