概览

在 General Translation 中会使用两种类型的 API key：

• Production API Key：用于在生产环境中翻译你的内容。
• Development API Key：用于在开发环境中翻译你的内容。

这两种 key 的行为不同，因此你应当根据所处环境谨慎选择正确的 key。

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-api-key

如果你将 gt-next 或 gt-react 作为独立的 i18n 库使用，则无需使用 API Key。

获取方式

行为

简单来说，Prod API key 会持久保存译文，而 Dev API key 不会。 进行原型试验时使用 Dev API key，准备上线部署时使用 Prod API key。

开发 API 密钥

此类密钥适用于测试和开发场景。 使用开发 API 密钥时，翻译将按需执行，并在内存中进行缓存。 翻译结果不会被持久化。

开发 API 密钥会被用于在浏览器中渲染的组件（客户端）以及服务端渲染的组件，以支持按需翻译。 这意味着它必须导出到客户端。 此密钥在生产环境中绝对不可使用，也绝对不可在生产环境中传递给客户端。

# Vite 开发环境 .env 文件示例
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # 仅用于开发环境

生产环境 API Key

使用生产环境 API key 时，翻译内容会被持久化。 这意味着翻译会被保存（存储在 CDN（内容分发网络）或你的应用打包产物中），以便在运行时使用。

此密钥会用于以下两个位置：

• gtx-cli 工具。查看文档了解更多信息。
• gt-next 库在生产构建中于运行时执行翻译时使用（仅限服务端，gt-react 不使用）。
  • <Tx> 和 tx 函数用于在运行时翻译内容。

该 API key 仅供服务器使用，切勿导出到客户端。

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # 该密钥绝不可暴露给客户端

说明

• 开发环境的 API key 用于测试和开发，仅应在开发环境中使用。
• 生产环境的 API key 用于正式环境。

后续步骤

• 了解如何使用<T> 组件，在开发环境中实时查看翻译。