Vite 中正确配置 API 请求路径:代理、别名与环境变量的区别与使用

夏敏吖_7451

夏敏吖_7451

2026-11-20

105人浏览

原创

Vite 中正确配置 API 请求路径:代理、别名与环境变量的区别与使用

Vite 的 resolve.alias 仅作用于模块导入(如 import),不参与 HTTP 请求路径解析;API 请求应通过 server.proxy 配合环境变量(如 import.meta.env.VITE_APP_API_URL)实现开发/生产环境的路径统一管理。

vite 的 `resolve.alias` 仅作用于模块导入(如 `import`),不参与 http 请求路径解析;api 请求应通过 `server.proxy` 配合环境变量(如 `import.meta.env.vite_app_api_url`)实现开发/生产环境的路径统一管理。

在 Vite 项目中,常有人误以为 resolve.alias(如 '@api': '/api')能像模块路径一样被 axios.post('@api/login') 自动解析为实际请求地址——但这是对 Vite 构建机制的根本误解。别名(alias)仅在编译期用于重写 import 语句的模块路径,例如 import api from '@api/utils';而 axios.post() 中的字符串是运行时由浏览器发起的真实 HTTP 请求路径,Vite 完全不会处理或替换该字符串中的任何别名。因此 @api/login 会被原样发送为 http://localhost:5173/@api/login,导致 404。

✅ 正确做法:用环境变量 + 代理协同工作
Vite 提供了开箱即用的环境变量机制,以 VITE_ 开头的变量会自动注入到客户端代码中(import.meta.env)。你只需在项目根目录创建 .env 文件:

# .env(开发环境)
VITE_APP_API_URL=/api
# .env.production(生产环境)
VITE_APP_API_URL=https://api.yourdomain.com

然后在组件中使用:

// src/composables/useAuth.ts
import axios from 'axios';

const API_BASE = import.meta.env.VITE_APP_API_URL;

export const login = (credentials: { username: string; password: string }) => {
  return axios.post(`${API_BASE}/login`, credentials)
    .then(res => {
      console.log('Login success:', res.data);
      return res.data;
    })
    .catch(err => {
      console.error('Login failed:', err.response?.data || err.message);
      throw err;
    });
};

同时,确保 vite.config.js 中的 server.proxy 配置与 VITE_APP_API_URL 的值保持一致(开发时为 /api):

Vitest Testing
Vitest Testing

Vitest 测试框架模式与最佳实践。适用于编写单元测试、集成测试、配置 vitest.config、使用 vi.mock/vi.fn 进行模拟等...

下载
server: {
  proxy: {
    '/api': {
      target: 'http://apiUrlForDevelopment', // 实际后端地址
      changeOrigin: true,
      rewrite: (path) => path.replace(/^\/api/, ''),
    }
  }
}

⚠️ 注意事项:

  • 环境变量名必须以 VITE_ 开头,否则不会暴露给前端代码;
  • 生产构建时,import.meta.env.VITE_APP_API_URL 会被静态替换为 .env.production 中的值(非运行时读取),确保安全性与确定性;
  • 不要混用别名与请求路径——@api 只适合导入本地 JS 模块(如 import { loginApi } from '@api/endpoints'),而非构造 URL 字符串;
  • 若需统一管理所有 API 调用,建议封装成自定义 Hook 或 Service 类,并在其中注入基础 URL,便于后续切换 Axios 实例或添加拦截器。

通过环境变量驱动 API 基础路径,配合 Vite 的代理能力,既能实现开发时的跨域转发,又可保障生产环境灵活部署,这才是现代前端工程中 API 配置的最佳实践。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vite 环境变量

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

6126

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1469

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

6024

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

1080

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2076

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

4125

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

5473

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3620

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

1168

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二期_大前端线上班
第二期_大前端线上班

共345课时 | 83.1万人学习