本页内容

本页内容

技术参考

密钥占位符约定

秘密占位符约定

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

推荐样式

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

在文档中避免这些模式

  • 字面量 PEM 私钥头或尾文本。
  • 类似于实时凭证的前缀,e.g. sk-...、xoxb-...、AKIA...。
  • 从运行时日志中复制的、看起来逼真的 bearer token。

示例

bash
# Goodexport OPENAI_API_KEY="example-openai-key-not-real" # Better (when the doc is about env wiring)export OPENAI_API_KEY="${OPENAI_API_KEY}"
本页有帮助吗?