快速开始

密钥占位符约定

密钥占位符约定

使用易于理解但不会与真实密钥混淆的占位符。

推荐样式

  • 优先使用描述性值,例如 example-openai-key-not-realexample-discord-bot-token
  • 在 shell 代码片段中,优先使用 ${OPENAI_API_KEY},而不是内联的类令牌字符串。
  • 确保示例显然是虚构的,并明确限定其用途(提供商、渠道、身份验证类型)。

文档中应避免的模式

  • PEM 私钥头部或尾部的字面文本。
  • 类似真实凭据的前缀,例如 sk-...xoxb-...AKIA...
  • 从运行时日志中复制的、看起来真实的持有者令牌。

示例

bash
# 推荐export OPENAI_API_KEY="example-openai-key-not-real" # 更佳(当文档介绍环境变量连接方式时)export OPENAI_API_KEY="${OPENAI_API_KEY}"
Was this useful?
On this page

On this page