はじめに
シークレットのプレースホルダー規則
シークレットのプレースホルダー規則
人間が読みやすく、実際のシークレットには見えないプレースホルダーを使用します。
推奨スタイル
example-openai-key-not-realやexample-discord-bot-tokenのような説明的な値を推奨します。- シェルスニペットでは、インラインのトークンのような文字列よりも
${OPENAI_API_KEY}を推奨します。 - 例は明らかに偽物だと分かるものにし、目的(プロバイダー、チャンネル、認証タイプ)に限定してください。
ドキュメントで避けるべきパターン
- PEM 秘密鍵のヘッダーまたはフッターのリテラルテキスト。
- 実際に使用されている認証情報に見える接頭辞(例:
sk-...、xoxb-...、AKIA...)。 - ランタイムログからコピーした、本物らしく見えるベアラートークン。
例
# 良い例export OPENAI_API_KEY="example-openai-key-not-real" # より良い例(ドキュメントが環境変数の接続方法に関する場合)export OPENAI_API_KEY="${OPENAI_API_KEY}"Was this useful?