Skip to main content

密钥占位符约定

使用易于阅读但不类似真实密钥的占位符。

推荐样式

  • 优先使用描述性值,例如 example-openai-key-not-realexample-discord-bot-token
  • 对于 shell 片段,优先使用 ${OPENAI_API_KEY},而不是内联的类令牌字符串。
  • 保持示例明显是伪造的,并且限定于其用途(提供商、通道、认证类型)。

在文档中避免这些模式

  • 真实的 PEM 私钥头或尾文本。
  • 看起来像有效凭据的前缀,例如 sk-...xoxb-...AKIA...
  • 从运行时日志中复制的、看起来很真实的 bearer 令牌。

示例

# 好
export OPENAI_API_KEY="example-openai-key-not-real"

# 更好(当文档内容是关于环境变量接线时)
export OPENAI_API_KEY="${OPENAI_API_KEY}"