API Keys

如何在 General Translation 中使用 API Keys

概览

General Translation 使用两种类型的 API Keys:

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

这两类密钥的行为有所不同,请务必根据所处环境使用正确的密钥。

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

如果你将 gt-nextgt-react 作为独立的 i18n 库使用,则无需使用 API Keys。


如何获取

General Translation 网站打开你的项目仪表板。

点击“API Keys”或“Developer Keys”选项卡。

点击“Create API Key”按钮。

复制该 API key,并将其粘贴到你项目的 .env 文件中。


行为

简单来说,Prod API Keys 会持久保存翻译,而 Dev API keys 不会。 在原型/开发阶段使用 Dev API keys;准备部署上线时使用 Prod API Keys。

开发用 API key

此类密钥适用于测试和开发场景。 使用开发用 API key 时,翻译将按需执行,并在内存中进行缓存。 翻译内容不会被保存。

开发用 API key 供在浏览器中渲染的组件(客户端)以及服务端渲染的组件使用,以支持按需翻译。 这意味着它必须暴露给客户端。 该密钥在生产环境中绝不可使用,也绝不可在生产环境中传递给客户端。

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

警告: 为方便在开发阶段进行客户端翻译,开发用 API key 会被传递到客户端。 这在开发环境下可以接受,但在生产环境中存在安全风险。 如果你的应用对外网可访问,切勿使用开发用 API key。

生产环境 API Key

使用生产环境 API key 时,翻译结果会被持久化。 也就是说,翻译会被保存(存储在 CDN 或应用的 bundle 中),以便在运行时使用。

此密钥用于两个场景:

  • gtx-cli 工具。参阅文档了解更多信息。
  • 生产构建中在运行时进行翻译时使用的 gt-next 库(仅限服务端,gt-react 不使用)。
    • <Tx>tx 函数用于在运行时翻译内容。

该 API key 仅供服务器使用,绝不能暴露给客户端。

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # 此密钥绝不应导出到客户端

注意事项

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

下一步

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

这份指南怎么样?

API Keys