Files
gin-vue-admin/aiDoc/examples/frontend/api-example.md
T
15e6e7685c update:发布2.9.2版本 (#2211)
* feat: 调整AI工作模式,更符合harness基准

* feat: 添加BusinessDB字段到PluginInitializeGorm结构体,并增加相关测试用例

* [middleware/jwt.go]: fix #2192 issues bug

* docs: add auto plugin design spec

* chore: ignore worktrees directory

* feat: 调整代码辅助能力至插件

* feat: 添加警告条组件,提示授权用户访问限制

* fix: 修正商业用途版权声明链接

* feat: 调整agent.md 更加节省token

* fix: 修改casbin版本为v3

* feat: 更新JSONMap和JSONSlice类型,优化GORM数据类型处理

* feat: 添加数据库就绪通知机制,优化插件注册流程

* feat: 重构API路径和描述,优化代码生成器和模板配置分组

* feat: 优化 person 页面的 css 作用域限制

* feat: 更新 vite 至 vite8

* 新增:MCP工具为指定URL的角色ID授权

* fix: 增加文件名合法性检查,拒绝包含非法字符的文件写入

* chore: 更新CI配置,升级Node.js和Go版本,调整checkout和setup动作版本

* feat: 为数据库连接增加最大复用时间配置

* feat: 为各数据库连接配置增加最大连接生命周期设置

* feat: 更新插件注册逻辑并优化API和菜单组件的标签显示

* feat: 更新版本号至v2.9.2并添加新插件路径信息

---------

Co-authored-by: taincheng <zhangtc@gmail.com>
Co-authored-by: Azir-11 <2075125282@qq.com>
Co-authored-by: lanxi <1220lanxi@gmail.com>
2026-05-11 13:48:18 +08:00

1.3 KiB

前端 API 示例

这个文件负责什么

前端 API 文件负责把后端接口封装成可复用函数,统一走 @/utils/request,不在组件里直接拼 axios 请求。

什么时候应该这样写

  • 新增模块接口
  • 给页面提供列表、详情、创建、更新、删除方法
  • 为插件页面补接口封装

推荐写法示例

import service from '@/utils/request'

// @Summary 分页获取订单列表
// @Router /order/getOrderList [post]
export const getOrderList = (data) => {
  return service({
    url: '/order/getOrderList',
    method: 'post',
    data
  })
}

// @Summary 创建订单
// @Router /order/createOrder [post]
export const createOrder = (data) => {
  return service({
    url: '/order/createOrder',
    method: 'post',
    data
  })
}

为什么这样写

  • 所有请求统一走 service,自动复用 token、loading、错误处理
  • 页面层只调用函数,不关心底层请求细节
  • JSDoc 风格的接口说明能帮助 AI 和协作者快速理解用途

常见错误

  • 在页面组件里直接写 axios
  • 把页面状态逻辑混进 API 文件
  • URL、method、参数位置写错,导致接口契约漂移

真实参考文件

  • web/src/api/user.js
  • web/src/plugin/announcement/api/info.js