接口文档
vue3-element-admin 提供了完善的接口文档支持。
在线接口文档
项目使用 Apifox 托管接口文档：
🔗 查看在线接口文档
接口地址
在线接口
bash
https://api.youlai.tech本地接口
Java 后端
bash
http://localhost:8989Node 后端
bash
http://localhost:3000接口请求
基础用法
typescript
import request from '@/utils/request'
// GET 请求
export function getUserList(params) {
return request({
url: '/api/v1/users',
method: 'get',
params
})
}
// POST 请求
export function addUser(data) {
return request({
url: '/api/v1/users',
method: 'post',
data
})
}请求拦截器
typescript
// 请求拦截器
request.interceptors.request.use(
(config) => {
// 添加 Token
const token = getToken()
if (token) {
config.headers.Authorization = `Bearer ${token}`
}
return config
},
(error) => {
return Promise.reject(error)
}
)响应拦截器
typescript
// 响应拦截器
request.interceptors.response.use(
(response) => {
const { code, data, msg } = response.data
if (code === '00000') {
return data
} else {
ElMessage.error(msg)
return Promise.reject(new Error(msg))
}
},
(error) => {
ElMessage.error(error.message)
return Promise.reject(error)
}
)接口规范
请求格式
typescript
{
url: string // 接口地址
method: string // 请求方法
params?: object // URL 参数
data?: object // 请求体
headers?: object // 请求头
}响应格式
typescript
{
code: string // 状态码
data: any // 响应数据
msg: string // 提示信息
}