ruoyi-vue-pro/API文档.md

Ruoyi-Vue-Pro API 文档

项目概述

Ruoyi-Vue-Pro 是一个基于 Spring Boot 的企业级管理系统，提供完整的 RESTful API 接口。本文档详细列出了系统提供的所有 API 接口。

API 基础信息

• 基础路径: /api
• 认证方式: Bearer Token (OAuth2)
• 响应格式: JSON
• 权限控制: 基于 Spring Security 的 @PreAuthorize 注解

通用响应格式

{
  "code": 0,
  "data": {},
  "msg": "操作成功"
}

---

1. 系统管理模块 (System)

1.1 用户管理 (User)

基础路径: /system/user

方法	路径	描述	权限
POST	/create	创建用户	system:user:create
PUT	/update	更新用户	system:user:update
DELETE	/delete	删除用户	system:user:delete
GET	/get	获取用户详情	system:user:query
GET	/page	分页查询用户	system:user:query
PUT	/update-password	修改密码	system:user:update-password
PUT	/update-status	修改用户状态	system:user:update

主要字段:

• id: 用户ID
• username: 用户名
• nickname: 昵称
• email: 邮箱
• mobile: 手机号
• status: 状态 (0=正常, 1=停用)

1.2 角色管理 (Role)

基础路径: /system/role

方法	路径	描述	权限
POST	/create	创建角色	system:role:create
PUT	/update	更新角色	system:role:update
DELETE	/delete	删除角色	system:role:delete
GET	/get	获取角色详情	system:role:query
GET	/page	分页查询角色	system:role:query
GET	/list-all-simple	获取所有角色列表	system:role:query

1.3 菜单管理 (Menu)

基础路径: /system/menu

方法	路径	描述	权限
POST	/create	创建菜单	system:menu:create
PUT	/update	更新菜单	system:menu:update
DELETE	/delete	删除菜单	system:menu:delete
GET	/get	获取菜单详情	system:menu:query
GET	/list	获取菜单列表	system:menu:query

1.4 部门管理 (Dept)

基础路径: /system/dept

方法	路径	描述	权限
POST	/create	创建部门	system:dept:create
PUT	/update	更新部门	system:dept:update
DELETE	/delete	删除部门	system:dept:delete
GET	/get	获取部门详情	system:dept:query
GET	/list	获取部门列表	system:dept:query

1.5 岗位管理 (Post)

基础路径: /system/post

方法	路径	描述	权限
POST	/create	创建岗位	system:post:create
PUT	/update	更新岗位	system:post:update
DELETE	/delete	删除岗位	system:post:delete
GET	/get	获取岗位详情	system:post:query
GET	/page	分页查询岗位	system:post:query

1.6 字典管理 (Dict)

字典类型: /system/dict-type 字典数据: /system/dict-data

方法	路径	描述	权限
POST	/create	创建字典	system:dict:create
PUT	/update	更新字典	system:dict:update
DELETE	/delete	删除字典	system:dict:delete
GET	/get	获取字典详情	system:dict:query
GET	/page	分页查询字典	system:dict:query

1.7 通知公告 (Notice)

基础路径: /system/notice

方法	路径	描述	权限
POST	/create	创建公告	system:notice:create
PUT	/update	更新公告	system:notice:update
DELETE	/delete	删除公告	system:notice:delete
GET	/get	获取公告详情	system:notice:query
GET	/page	分页查询公告	system:notice:query

1.8 操作日志 (OperateLog)

基础路径: /system/operate-log

方法	路径	描述	权限
GET	/page	分页查询操作日志	system:operate-log:query
GET	/export-excel	导出操作日志	system:operate-log:export

1.9 登录日志 (LoginLog)

基础路径: /system/login-log

方法	路径	描述	权限
GET	/page	分页查询登录日志	system:login-log:query
GET	/export-excel	导出登录日志	system:login-log:export

1.10 邮件管理 (Mail)

邮件账号: /system/mail-account 邮件模板: /system/mail-template 邮件日志: /system/mail-log

方法	路径	描述	权限
POST	/create	创建	system:mail:create
PUT	/update	更新	system:mail:update
DELETE	/delete	删除	system:mail:delete
GET	/get	获取详情	system:mail:query
GET	/page	分页查询	system:mail:query

1.11 短信管理 (SMS)

短信渠道: /system/sms-channel 短信模板: /system/sms-template 短信日志: /system/sms-log

方法	路径	描述	权限
POST	/create	创建	system:sms:create
PUT	/update	更新	system:sms:update
DELETE	/delete	删除	system:sms:delete
GET	/get	获取详情	system:sms:query
GET	/page	分页查询	system:sms:query
POST	/send-sms	发送短信	system:sms:send

1.12 OAuth2 认证

基础路径: /system/oauth2

方法	路径	描述	权限
POST	/token	获取访问令牌	-
POST	/revoke	撤销访问令牌	-
POST	/check-token	验证访问令牌	-

1.13 租户管理 (Tenant)

基础路径: /system/tenant

方法	路径	描述	权限
POST	/create	创建租户	system:tenant:create
PUT	/update	更新租户	system:tenant:update
DELETE	/delete	删除租户	system:tenant:delete
GET	/get	获取租户详情	system:tenant:query
GET	/page	分页查询租户	system:tenant:query

---

2. 支付管理模块 (Pay)

2.1 支付订单 (PayOrder)

基础路径: /pay/order

方法	路径	描述	权限
POST	/create	创建支付订单	pay:order:create
PUT	/update	更新支付订单	pay:order:update
GET	/get	获取订单详情	pay:order:query
GET	/page	分页查询订单	pay:order:query
POST	/submit	提交支付	pay:order:submit

2.2 支付退款 (PayRefund)

基础路径: /pay/refund

方法	路径	描述	权限
POST	/create	创建退款	pay:refund:create
GET	/get	获取退款详情	pay:refund:query
GET	/page	分页查询退款	pay:refund:query

2.3 支付渠道 (PayChannel)

基础路径: /pay/channel

方法	路径	描述	权限
POST	/create	创建支付渠道	pay:channel:create
PUT	/update	更新支付渠道	pay:channel:update
DELETE	/delete	删除支付渠道	pay:channel:delete
GET	/get	获取渠道详情	pay:channel:query
GET	/page	分页查询渠道	pay:channel:query

2.4 钱包管理 (PayWallet)

基础路径: /pay/wallet

方法	路径	描述	权限
GET	/get	获取钱包详情	pay:wallet:query
GET	/page	分页查询钱包	pay:wallet:query
POST	/transfer	钱包转账	pay:wallet:transfer

2.5 钱包充值 (PayWalletRecharge)

基础路径: /pay/wallet/recharge

方法	路径	描述	权限
POST	/create	创建充值订单	pay:wallet-recharge:create
GET	/get	获取充值详情	pay:wallet-recharge:query
GET	/page	分页查询充值	pay:wallet-recharge:query

2.6 钱包交易记录 (PayWalletTransaction)

基础路径: /pay/wallet/transaction

方法	路径	描述	权限
GET	/page	分页查询交易记录	pay:wallet-transaction:query

2.7 转账管理 (PayTransfer)

基础路径: /pay/transfer

方法	路径	描述	权限
POST	/create	创建转账	pay:transfer:create
GET	/get	获取转账详情	pay:transfer:query
GET	/page	分页查询转账	pay:transfer:query

---

3. 会员管理模块 (Member)

3.1 会员用户 (MemberUser)

基础路径: /member/user

方法	路径	描述	权限
GET	/get	获取会员详情	member:user:query
GET	/page	分页查询会员	member:user:query
PUT	/update	更新会员信息	member:user:update

3.2 会员等级 (MemberLevel)

基础路径: /member/level

方法	路径	描述	权限
POST	/create	创建会员等级	member:level:create
PUT	/update	更新会员等级	member:level:update
DELETE	/delete	删除会员等级	member:level:delete
GET	/get	获取等级详情	member:level:query
GET	/page	分页查询等级	member:level:query

3.3 会员积分 (MemberPoint)

基础路径: /member/point

方法	路径	描述	权限
POST	/add	增加积分	member:point:add
POST	/reduce	减少积分	member:point:reduce
GET	/record/page	分页查询积分记录	member:point:query

3.4 会员签到 (MemberSignIn)

基础路径: /member/sign-in

方法	路径	描述	权限
POST	/create	创建签到配置	member:sign-in:create
PUT	/update	更新签到配置	member:sign-in:update
GET	/config/page	分页查询签到配置	member:sign-in:query
GET	/record/page	分页查询签到记录	member:sign-in:query

3.5 会员标签 (MemberTag)

基础路径: /member/tag

方法	路径	描述	权限
POST	/create	创建会员标签	member:tag:create
PUT	/update	更新会员标签	member:tag:update
DELETE	/delete	删除会员标签	member:tag:delete
GET	/page	分页查询标签	member:tag:query

3.6 会员分组 (MemberGroup)

基础路径: /member/group

方法	路径	描述	权限
POST	/create	创建会员分组	member:group:create
PUT	/update	更新会员分组	member:group:update
DELETE	/delete	删除会员分组	member:group:delete
GET	/page	分页查询分组	member:group:query

3.7 收货地址 (Address)

基础路径: /member/address

方法	路径	描述	权限
POST	/create	创建收货地址	member:address:create
PUT	/update	更新收货地址	member:address:update
DELETE	/delete	删除收货地址	member:address:delete
GET	/get	获取地址详情	member:address:query
GET	/page	分页查询地址	member:address:query

---

4. 商城管理模块 (Mall)

4.1 商品管理 (Product)

商品SPU: /product/spu 商品SKU: /product/sku

方法	路径	描述	权限
POST	/create	创建商品	product:spu:create
PUT	/update	更新商品	product:spu:update
DELETE	/delete	删除商品	product:spu:delete
GET	/get	获取商品详情	product:spu:query
GET	/page	分页查询商品	product:spu:query
PUT	/update-status	更新商品状态	product:spu:update

4.2 商品分类 (Category)

基础路径: /product/category

方法	路径	描述	权限
POST	/create	创建分类	product:category:create
PUT	/update	更新分类	product:category:update
DELETE	/delete	删除分类	product:category:delete
GET	/get	获取分类详情	product:category:query
GET	/list	获取分类列表	product:category:query

4.3 商品品牌 (Brand)

基础路径: /product/brand

方法	路径	描述	权限
POST	/create	创建品牌	product:brand:create
PUT	/update	更新品牌	product:brand:update
DELETE	/delete	删除品牌	product:brand:delete
GET	/get	获取品牌详情	product:brand:query
GET	/page	分页查询品牌	product:brand:query

4.4 购物车 (Cart)

基础路径: /product/cart

方法	路径	描述	权限
POST	/add	添加到购物车	-
PUT	/update-count	更新购物车数量	-
DELETE	/delete	删除购物车商品	-
GET	/list	获取购物车列表	-
DELETE	/clear	清空购物车	-

4.5 订单管理 (Order)

基础路径: /trade/order

方法	路径	描述	权限
POST	/create	创建订单	-
GET	/get	获取订单详情	-
GET	/page	分页查询订单	-
PUT	/cancel	取消订单	-
PUT	/confirm	确认收货	-

4.6 优惠活动 (Promotion)

基础路径: /promotion

方法	路径	描述	权限
POST	/activity/create	创建活动	promotion:activity:create
PUT	/activity/update	更新活动	promotion:activity:update
DELETE	/activity/delete	删除活动	promotion:activity:delete
GET	/activity/page	分页查询活动	promotion:activity:query

---

5. 业务流程管理模块 (BPM)

5.1 流程模型 (BpmModel)

基础路径: /bpm/model

方法	路径	描述	权限
POST	/create	创建流程模型	bpm:model:create
PUT	/update	更新流程模型	bpm:model:update
DELETE	/delete	删除流程模型	bpm:model:delete
GET	/get	获取模型详情	bpm:model:query
GET	/page	分页查询模型	bpm:model:query
POST	/deploy	部署流程模型	bpm:model:deploy

5.2 流程定义 (BpmDefinition)

基础路径: /bpm/definition

方法	路径	描述	权限
GET	/list	获取流程定义列表	bpm:definition:query
GET	/get	获取流程定义详情	bpm:definition:query

5.3 流程实例 (BpmInstance)

基础路径: /bpm/instance

方法	路径	描述	权限
POST	/create	创建流程实例	bpm:instance:create
GET	/get	获取实例详情	bpm:instance:query
GET	/page	分页查询实例	bpm:instance:query
POST	/cancel	取消流程实例	bpm:instance:cancel

5.4 流程任务 (BpmTask)

基础路径: /bpm/task

方法	路径	描述	权限
GET	/todo-page	待办任务分页	bpm:task:query
GET	/done-page	已办任务分页	bpm:task:query
POST	/approve	审批任务	bpm:task:approve
POST	/reject	拒绝任务	bpm:task:reject
POST	/delegate	委派任务	bpm:task:delegate

---

6. 企业资源计划模块 (ERP)

6.1 产品管理 (ErpProduct)

基础路径: /erp/product

方法	路径	描述	权限
POST	/create	创建产品	erp:product:create
PUT	/update	更新产品	erp:product:update
DELETE	/delete	删除产品	erp:product:delete
GET	/get	获取产品详情	erp:product:query
GET	/page	分页查询产品	erp:product:query

6.2 采购管理 (ErpPurchase)

基础路径: /erp/purchase

方法	路径	描述	权限
POST	/create	创建采购订单	erp:purchase:create
PUT	/update	更新采购订单	erp:purchase:update
DELETE	/delete	删除采购订单	erp:purchase:delete
GET	/get	获取采购详情	erp:purchase:query
GET	/page	分页查询采购	erp:purchase:query

6.3 销售管理 (ErpSale)

基础路径: /erp/sale

方法	路径	描述	权限
POST	/create	创建销售订单	erp:sale:create
PUT	/update	更新销售订单	erp:sale:update
DELETE	/delete	删除销售订单	erp:sale:delete
GET	/get	获取销售详情	erp:sale:query
GET	/page	分页查询销售	erp:sale:query

6.4 库存管理 (ErpStock)

基础路径: /erp/stock

方法	路径	描述	权限
POST	/in	入库	erp:stock:in
POST	/out	出库	erp:stock:out
GET	/page	分页查询库存	erp:stock:query

---

7. 物联网模块 (IoT)

7.1 设备管理 (IotDevice)

基础路径: /iot/device

方法	路径	描述	权限
POST	/create	创建设备	iot:device:create
PUT	/update	更新设备	iot:device:update
DELETE	/delete	删除设备	iot:device:delete
GET	/get	获取设备详情	iot:device:query
GET	/page	分页查询设备	iot:device:query
POST	/control	控制设备	iot:device:control

7.2 设备数据 (IotData)

基础路径: /iot/data

方法	路径	描述	权限
GET	/latest	获取最新数据	iot:data:query
GET	/history	获取历史数据	iot:data:query

---

8. 人工智能模块 (AI)

8.1 AI 聊天 (AiChat)

对话管理: /ai/chat/conversation 消息管理: /ai/chat/message

方法	路径	描述	权限
POST	/conversation/create	创建对话	ai:chat:create
PUT	/conversation/update	更新对话	ai:chat:update
DELETE	/conversation/delete	删除对话	ai:chat:delete
GET	/conversation/page	分页查询对话	ai:chat:query
POST	/message/send	发送消息（段式）	ai:chat:send
POST	/message/send-stream	发送消息（流式）	ai:chat:send
GET	/message/list-by-conversation-id	获取对话消息列表	ai:chat:query

8.2 AI 绘画 (AiImage)

基础路径: /ai/image

方法	路径	描述	权限
POST	/draw	生成图片	ai:image:draw
GET	/my-page	获取我的绘图分页	ai:image:query
GET	/public-page	获取公开绘图分页	ai:image:query
GET	/get-my	获取我的绘图记录	ai:image:query
DELETE	/delete-my	删除我的绘画记录	ai:image:delete

8.3 AI 知识库 (AiKnowledge)

知识库管理: /ai/knowledge 文档管理: /ai/knowledge/document 分段管理: /ai/knowledge/segment

方法	路径	描述	权限
POST	/create	创建知识库	ai:knowledge:create
PUT	/update	更新知识库	ai:knowledge:update
DELETE	/delete	删除知识库	ai:knowledge:delete
GET	/page	分页查询知识库	ai:knowledge:query
POST	/document/create	上传文档	ai:knowledge:upload
POST	/document/create-list	批量上传文档	ai:knowledge:upload
PUT	/document/update-status	更新文档状态	ai:knowledge:update
GET	/segment/page	分页查询分段	ai:knowledge:query
POST	/segment/search	搜索知识库	ai:knowledge:search

8.4 AI 模型 (AiModel)

基础路径: /ai/model

方法	路径	描述	权限
POST	/create	创建模型	ai:model:create
PUT	/update	更新模型	ai:model:update
DELETE	/delete	删除模型	ai:model:delete
GET	/page	分页查询模型	ai:model:query

8.5 AI 工具 (AiTool)

基础路径: /ai/tool

方法	路径	描述	权限
POST	/create	创建工具	ai:tool:create
PUT	/update	更新工具	ai:tool:update
DELETE	/delete	删除工具	ai:tool:delete
GET	/page	分页查询工具	ai:tool:query

8.6 AI 工作流 (AiWorkflow)

基础路径: /ai/workflow

方法	路径	描述	权限
POST	/create	创建工作流	ai:workflow:create
PUT	/update	更新工作流	ai:workflow:update
DELETE	/delete	删除工作流	ai:workflow:delete
GET	/get	获取工作流详情	ai:workflow:query
GET	/page	分页查询工作流	ai:workflow:query
POST	/test	测试工作流	ai:workflow:test

8.7 AI 写作 (AiWrite)

基础路径: /ai/write

方法	路径	描述	权限
POST	/generate	生成内容	ai:write:generate
GET	/page	分页查询写作记录	ai:write:query

8.8 AI 思维导图 (AiMindMap)

基础路径: /ai/mindmap

方法	路径	描述	权限
POST	/generate	生成思维导图	ai:mindmap:generate
GET	/page	分页查询思维导图	ai:mindmap:query

8.9 AI 音乐 (AiMusic)

基础路径: /ai/music

方法	路径	描述	权限
POST	/generate	生成音乐	ai:music:generate
GET	/page	分页查询音乐	ai:music:query
PUT	/update	更新音乐	ai:music:update

---

9. 数字化服装模块 (Digital)

9.1 服装管理 (DigitalCloth)

基础路径: /cloth

方法	路径	描述	权限
POST	/addRoom	添加房间	-
POST	/delRoom	删除房间	-
POST	/updateRoom	更新房间	-
POST	/getRoomList	获取房间列表	-
POST	/addRoomCloth	添加房间服装	-
POST	/delRoomCloth	删除房间服装	-
POST	/getRoomClothList	获取房间服装列表	-
POST	/buyLink	购买链接	-

9.2 记录管理 (Records)

基础路径: /records

方法	路径	描述	权限
POST	/create	创建记录	-
PUT	/update	更新记录	-
DELETE	/delete	删除记录	-
GET	/page	分页查询记录	-

9.3 在线记录 (OnRecord)

基础路径: /on-record

方法	路径	描述	权限
POST	/create	创建在线记录	-
GET	/page	分页查询在线记录	-

9.4 换发管理 (TjSwapHair)

基础路径: /swap-hair

方法	路径	描述	权限
POST	/exchange	换发	-
GET	/page	分页查询换发记录	-

9.5 三方图片 (SysTripleImage)

基础路径: /triple-image

方法	路径	描述	权限
POST	/create	创建三方图片	-
PUT	/update	更新三方图片	-
DELETE	/delete	删除三方图片	-
GET	/page	分页查询三方图片	-

---

10. 报表模块 (Report)

10.1 GoView 项目 (GoViewProject)

基础路径: /report/go-view/project

方法	路径	描述	权限
POST	/create	创建项目	report:go-view-project:create
PUT	/update	更新项目	report:go-view-project:update
DELETE	/delete	删除项目	report:go-view-project:delete
GET	/get	获取项目详情	report:go-view-project:query
GET	/my-page	获取我的项目分页	report:go-view-project:query

10.2 GoView 数据 (GoViewData)

基础路径: /report/go-view/data

方法	路径	描述	权限
POST	/get-by-sql	通过SQL获取数据	report:go-view-data:query

---

11. 基础设施模块 (Infra)

11.1 文件管理 (File)

基础路径: /infra/file

方法	路径	描述	权限
POST	/upload	上传文件	infra:file:upload
DELETE	/delete	删除文件	infra:file:delete
GET	/get	获取文件详情	infra:file:query

11.2 文件配置 (FileConfig)

基础路径: /infra/file/config

方法	路径	描述	权限
POST	/create	创建文件配置	infra:file-config:create
PUT	/update	更新文件配置	infra:file-config:update
DELETE	/delete	删除文件配置	infra:file-config:delete
GET	/page	分页查询文件配置	infra:file-config:query

11.3 定时任务 (Job)

基础路径: /infra/job

方法	路径	描述	权限
POST	/create	创建定时任务	infra:job:create
PUT	/update	更新定时任务	infra:job:update
DELETE	/delete	删除定时任务	infra:job:delete
GET	/get	获取任务详情	infra:job:query
GET	/page	分页查询任务	infra:job:query
PUT	/trigger	触发任务	infra:job:trigger
PUT	/update-status	更新任务状态	infra:job:update

11.4 任务日志 (JobLog)

基础路径: /infra/job-log

方法	路径	描述	权限
GET	/get	获取日志详情	infra:job-log:query
GET	/page	分页查询日志	infra:job-log:query

11.5 API 访问日志 (ApiAccessLog)

基础路径: /infra/api-access-log

方法	路径	描述	权限
GET	/page	分页查询访问日志	infra:api-access-log:query

11.6 API 错误日志 (ApiErrorLog)

基础路径: /infra/api-error-log

方法	路径	描述	权限
GET	/page	分页查询错误日志	infra:api-error-log:query

11.7 数据源配置 (DataSourceConfig)

基础路径: /infra/data-source-config

方法	路径	描述	权限
POST	/create	创建数据源配置	infra:data-source-config:create
PUT	/update	更新数据源配置	infra:data-source-config:update
DELETE	/delete	删除数据源配置	infra:data-source-config:delete
GET	/page	分页查询数据源配置	infra:data-source-config:query

11.8 系统配置 (Config)

基础路径: /infra/config

方法	路径	描述	权限
PUT	/update	更新配置	infra:config:update
GET	/get	获取配置	infra:config:query

11.9 代码生成 (Codegen)

基础路径: /infra/codegen

方法	路径	描述	权限
POST	/create-list	创建代码生成配置	infra:codegen:create
PUT	/update	更新代码生成配置	infra:codegen:update
DELETE	/delete	删除代码生成配置	infra:codegen:delete
GET	/page	分页查询代码生成配置	infra:codegen:query
POST	/preview	预览代码	infra:codegen:preview
POST	/download	下载代码	infra:codegen:download

11.10 Redis 管理 (Redis)

基础路径: /infra/redis

方法	路径	描述	权限
GET	/get	获取 Redis 键值	infra:redis:query
DELETE	/delete	删除 Redis 键	infra:redis:delete
GET	/keys	获取 Redis 键列表	infra:redis:query

---

附录

A. 通用错误码

错误码	描述
0	成功
1	服务器内部错误
401	未授权
403	禁止访问
404	资源不存在
500	服务器错误

B. 权限说明

系统采用基于角色的权限控制（RBAC），每个 API 接口都需要相应的权限才能访问。权限格式为 模块:功能:操作，例如：

• system:user:create - 系统用户创建权限
• pay:order:query - 支付订单查询权限

C. 分页参数

所有分页接口支持以下通用参数：

参数名	类型	必填	描述
pageNo	Integer	是	页码，从 1 开始
pageSize	Integer	是	每页数量

D. 排序参数

分页接口支持排序参数：

参数名	类型	必填	描述
sortField	String	否	排序字段
sortOrder	String	否	排序方向：asc/desc

---

版本历史

版本	日期	说明
1.0.0	2026-01-03	初始版本

---

文档生成时间: 2026-01-03 项目名称: Ruoyi-Vue-Pro 文档版本: 1.0.0