Skip to content

目录结构 ​

vue3-element-admin 的顶层目录:

text
vue3-element-admin
├── mock                    # Mock 接口,VITE_MOCK_ENABLED 开启时生效
├── public                  # 静态资源,构建后原样复制
├── src
│   ├── api                 # 接口模块,按业务域划分
│   ├── assets              # 图片、图标等构建资源
│   ├── components          # 全局组件,自动注册
│   ├── composables         # 全局组合式函数
│   ├── constants           # 常量
│   ├── directives          # 自定义指令,如 v-has-perm
│   ├── enums               # 枚举
│   ├── lang                # 国际化语言包
│   ├── layouts             # 布局与模式(侧边栏、顶部菜单等)
│   ├── plugins             # 插件注册
│   ├── router              # 路由与守卫
│   ├── stores              # Pinia 状态模块
│   ├── styles              # 全局样式与 SCSS 变量
│   ├── utils               # 工具函数
│   ├── views               # 页面,按业务域划分
│   ├── App.vue
│   ├── main.ts
│   └── settings.ts         # 布局、主题等默认设置
├── types                   # 全局类型声明,含自动生成文件
├── .env.development        # 开发环境变量
├── .env.production         # 生产环境变量
├── vite.config.ts
├── uno.config.ts           # UnoCSS 配置
├── eslint.config.ts
└── tsconfig.json

接口模块 ​

每个业务域一个目录,index.ts 导出 API 对象,types.ts 定义类型并随 index 重导出:

text
src/api/system/user
├── index.ts                # const UserAPI = { getPage, create, ... }
└── types.ts                # UserQuery、UserItem、UserForm
typescript
import UserAPI from "@/api/system/user";
import type { UserItem } from "@/api/system/user";

页面 ​

页面放在 src/views/{业务域}/{模块}/index.vue,与菜单的页面组件路径对应,见路由与菜单。页面私有组件放在同目录 components/ 下。

自动生成文件 ​

types/auto-imports.d.ts 和 types/components.d.ts 由 unplugin 插件生成,不要手动编辑。全局组件和 Vue API 无需 import 即可使用。

相关文档 ​

基于 MIT 许可发布 · 如需部署协助或二开定制,请查看 支持与合作