API 密钥

概述

General Translation 使用两种类型的 API 密钥：

这两种类型的密钥行为不同，因此您应该小心使用适合您所在环境的正确密钥。

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

如果您将 gt-next 或 gt-react 作为独立的 i18n 库使用，则不需要使用 API 密钥。

前往你的项目仪表盘，在 General Translation 网站上。

点击 "API Keys" 或 "Developer Keys" 标签页。

点击 "Create API Key" 按钮。

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

最简单地说，Prod API 密钥会持久化翻译，而 Dev API 密钥不会。您使用 Dev API 密钥来原型化翻译，使用 Prod API 密钥来准备部署。

这种类型的密钥对于测试和开发目的很有用。当使用开发 API 密钥时，翻译是按需进行的，并在内存中进行记忆化。翻译不会被保存。

开发 API 密钥被浏览器中渲染的组件（客户端）和服务器端渲染的组件使用，以促进按需翻译。这意味着它必须导出到客户端。这个密钥绝不应该在生产环境中使用，也绝不应该在生产环境中传递给客户端。

# example Vite .env file for dev
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # Only used in development

警告： 开发 API 密钥会传递给客户端，以便在开发中促进客户端翻译。这在开发环境中是可以的，但在生产环境中是一个安全风险。如果您的应用程序对互联网开放，您绝不应该使用开发 API 密钥。

当使用生产 API 密钥时，翻译会被持久化。这意味着翻译将被保存（在 CDN 中或在您的应用程序包中）以在运行时使用。

这个密钥在两个地方使用：

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

API 密钥仅由服务器使用，绝不应该导出到客户端。

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # This key should never be exported to the client