環境変数名をPOSIX規則でチェック
環境変数名がどの環境でも使えるかを、デプロイで問題になる前に確認できます。DATABASE_URLは有効ですが、数字で始まる名前やハイフンを含む名前は、違反した規則を示して不合格になります。ブラウザで無料で使えます。
- 無料
- ブラウザで動作
- 登録不要
- データは端末の外に出ません
無料で実行
計算例
- テキスト
- DATABASE_URL
- 名前
- DATABASE_URL
- 規約
- POSIX
環境変数名は単純に見えますが、先頭の数字、ハイフン、空白、移植性のない文字が原因でデプロイに失敗することがあります。この検証ではPOSIXの命名規則に従い、ASCII英字・数字・アンダースコアを認め、先頭だけは英字またはアンダースコアに限定します。正しい場合は明確に確認し、誤りがある場合は違反した規則を示します。エディター、設定フォーム、CI、構成生成処理に安心して組み込めます。
検証で認められる名前
移植可能な環境変数名では、意図的に限定された文字だけを使います。先頭はAからZまたはaからzのASCII英字、もしくはアンダースコアでなければなりません。2文字目以降では0から9の数字も使えます。
そのため、DATABASE_URL、HOME、_INTERNAL_FLAG、API2_TOKENは有効です。入力全体を検査し、修正、正規化、空白の除去は行いません。黙って整形すると、入力された値とは別の識別子になり得るためです。
大文字と小文字は保持され、PATHとPathは別名として扱われます。この処理が確認するのは移植可能な構文だけです。変数が実在するか、export済みか、値があるか、特定のプログラムが対応するかは調べません。
成功時には元の名前、validの結果、適用した規則の確認メッセージを返します。
無効な名前の説明方法
誤りの種類ごとに、修正しやすい説明を返します。空文字列には先頭文字がないため失敗します。数字で始まる名前は、後続位置なら数字を使える場合でも、先頭専用の規則に違反します。
先頭のハイフン、ピリオド、空白、ASCII以外の文字も認められません。先頭が正しく、途中に禁止文字がある場合は、その文字と1から数えた位置を示します。NAME=valueのような代入式も変数名とはみなさず、等号を拒否します。
開発工程への組み込み方
設定がシェルやプロセス環境へ渡る前に名前を受け付ける場面で利用できます。デプロイ用フォームでは送信時にキーを確認し、修正すべき規則を表示できます。構成ジェネレーターでは、dotenvファイル、コンテナマニフェスト、サービス定義、CIシークレット対応表を作る前に不正なキーを拒否できます。
リンターやリポジトリ検査でも、テンプレートと例に同じ決定的な規則を適用できます。ネットワーク接続、プロセス環境の読み取り、入力保存、現在時刻、乱数は使用しません。なお構文が正しくても、個別ツールが追加規則や予約済み接頭辞を設けている場合があります。
活用例
デプロイ設定の事前確認
実行環境で正しく公開できない設定を保存する前に、変数名を検証できます。
dotenv生成処理の保護
アプリケーション起動時まで発覚しない不正なキーを、ファイル生成前に拒否できます。
CIに命名チェックを追加
リポジトリ検査で、構成テンプレートと記載済みの変数名を決定的な規則により確認できます。
よくある質問
使用できる文字は何ですか？
ASCII英字、数字、アンダースコアを使用できます。先頭はASCII英字またはアンダースコアに限ります。
数字から始められますか？
できません。 数字は2文字目以降だけで使えます。2FA_TOKENは失敗し、TOKEN_2FAは成功します。
変数が存在するかも確認しますか？
確認しません。 候補名だけを検証し、環境の読み取りやexport、値の代入状況は調べません。
小文字の名前も有効ですか？
有効です。 ASCIIの大文字と小文字を使用でき、入力された表記をそのまま保持します。
無効な名前を自動で直したり空白を削ったりしますか？
しません。入力された文字列全体をそのまま確認し、空白の削除や文字の修正は行いません。黙って整えると別の名前に変わってしまうおそれがあるためで、代わりにどの規則にどこで違反したかを示します。
関連ツール
開発者向け — APIアクセス
このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。
エンドポイント
Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。
お使いのスタックから呼び出す
curl -X POST https://api.kit.forhosting.com/dev/env-var-name-validate \
-H "Authorization: Bearer $KIT_KEY" \
-H "Content-Type: application/json" \
-d '{"text":"DATABASE_URL"}'const res = await fetch("https://api.kit.forhosting.com/dev/env-var-name-validate", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.KIT_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"text": "DATABASE_URL"
})
});
const { task_id } = await res.json();import os, requests
res = requests.post(
"https://api.kit.forhosting.com/dev/env-var-name-validate",
headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
json={
"text": "DATABASE_URL"
},
)
task_id = res.json()["task_id"]<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev/env-var-name-validate", false, stream_context_create([
"http" => [
"method" => "POST",
"header" => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
"content" => '{"text":"DATABASE_URL"}',
],
]));
$task = json_decode($res, true);body := bytes.NewBufferString(`{"text":"DATABASE_URL"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev/env-var-name-validate", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)リクエスト例
{
"text": "DATABASE_URL"
}レスポンス例
{
"task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
"type": "dev.env_var_name_validate",
"status": "queued",
"_links": {
"result": "/tasks/tsk_…/result"
}
}非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。
料金
単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。
エラー
| HTTP | コード | 意味 |
|---|---|---|
401 | unauthorized | APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。 |
402 | insufficient_balance | 残高が不足しています。チャージ後に再度お試しください。 |
404 | unknown_type | 指定されたタスクタイプは存在しません。タイプ名を確認してください。 |
429 | rate_limited | リクエストが多すぎます。しばらく待ってから再度お試しください。 |
技術的な注記
無効な名前の説明方法
たとえばAPI-KEYはハイフン、API KEYは空白で失敗します。エラーコードにはinvalid_inputを使うため、APIクライアントは入力の修正で解決できる問題と内部障害を区別でき、通信メッセージを解析する必要もありません。
開発工程への組み込み方
そのため、ブラウザー、自動テスト、APIのどこでも同じ結果になります。APIリクエストの料金は$0.002です。
技術的な質問
ハイフンやピリオドは使えますか？
使えません。ハイフン、ピリオド、空白、等号などが含まれるとinvalid_inputになります。
APIリクエストの料金はいくらですか？
APIリクエスト1回につき$0.002です。同じ決定的な検証をブラウザーでも実行できます。