ForHosting KIT · 開発者向けツール

代替テキスト付きREADMEバッジMarkdownを生成

ラベル、メッセージ、色を指定するだけで、Shieldsのパス構文を覚えなくてもREADMEへそのまま貼り付けられるバッジを作成できます。完全なMarkdown、画像URL、人が読める代替テキストを個別のフィールドで返します。空白、ハイフン、アンダースコア、句読点、Markdownで意味を持つ角括弧を安全に処理するため、実際のビルドジョブやリリースチャンネルを表す名前でも構造が崩れません。単発のバッジにはブラウザ版を、ドキュメントを自動生成する場合には決定的なAPIをご利用ください。

● Beta無料・ブラウザ内で実行

無料で実行 API仕様を見る

ご利用方法ウェブAPIメールTelegramアプリ近日

状態が伝わる簡潔なバッジ文言を選びます

役に立つバッジは、小さく具体的な問いに一目で答えます。左側のラベルには分類を、右側のメッセージには現在の値を指定してください。たとえば「ビルド」というラベルと「成功」というメッセージの組み合わせは、長い文章を1枚の画像に詰め込むより確認しやすくなります。生成される代替テキストは両方の値をコロンで結ぶため、スクリーンリーダーを利用する方にも視覚表示と同じ基本関係が伝わります。重要な状態を色だけで示さないよう、どちらの値も色がなくても意味を理解できる表現にしてください。外側の空白は除去されますが、意図した文言と大文字・小文字は維持されます。空のラベルやメッセージは、片側が空白の分かりにくい画像を作らず、入力エラーとして拒否されます。自動処理を示す場合は、リリース間で安定した語彙を使うと差分が読みやすくなります。返却されるalt_textフィールドにより、完成したMarkdownから切り離してアクセシブルな説明を確認したり再利用したりできます。

Shields画像URLの作られ方を理解します

Shieldsの静的バッジでは、ラベル、メッセージ、色を画像パス内にエンコードします。このパスには特別な区切り規則があります。空白はアンダースコアに変換され、文字としてのアンダースコアは2個に、文字としてのハイフンも2個になります。これにより、バッジ各部の区切りと入力中の文字を混同しません。それ以外の記号は、有効なURLになるようパーセントエンコードされます。本機能はこれらの変換を決定的に適用し、完成したURLをMarkdownとともに返します。16進色は先頭にハッシュ記号を付けても指定でき、パスへ入る前にその記号だけを除去します。brightgreenのようなShieldsの色名も直接指定できます。サービスはShieldsへ接続せず、特定の色名がどのように描画されるかも検証しません。標準的な画像参照だけを生成するため、高速かつ非公開で、オフラインのドキュメント生成にも適しています。成功結果は構文が正しく作られたことを示しますが、遠隔画像を取得できたことまでは示しません。出力をテンプレートに保存し、最終的なREADME閲覧時に通常どおり画像を読み込ませることができます。

生成したMarkdownを安全に挿入し自動化します

markdownフィールドをREADME、プルリクエストのテンプレート、パッケージページ、または外部画像を許可するMarkdown文書へコピーしてください。結果は、角括弧内にアクセシブルな文言、丸括弧内にShieldsのURLを置く一般的な画像構文です。表示文言に含まれる角括弧とバックスラッシュはエスケープされるため、利用者が指定した文字列によって代替テキスト部分が途中で閉じることはありません。自動処理では、ドキュメントを描画するたびに3つの入力フィールドを送り、返却されたmarkdown値を目的の場所へ書き込んでください。アルゴリズムは時刻、乱数、状態、ネットワークに依存しないので、同じ入力から常に同じ出力が得られ、生成ファイルのバージョン管理も安定します。バッジの配置や順番は、お使いのテンプレート側で管理することをおすすめします。本機能は1回の要求につきバッジを1個だけ作り、リポジトリの編集、ビルド結果の検査、表示する状態の判断は行いません。前段の自動処理が正しい情報を提供し、本生成器はエンコードと表示だけを担当します。

活用例

ビルド状態のプレースホルダーを追加

継続的インテグレーションが現在のメッセージを提供する前に、READMEテンプレート用の一貫したMarkdownを作成します。

パッケージの互換性を記載

実行環境のラベルと対応バージョンを、適切な代替テキスト付きのコンパクトなバッジへ変換します。

リリース文書を自動生成

Shieldsパスのエスケープ処理を独自実装せず、ドキュメント生成内で決定的なバッジ断片を作成します。

よくある質問

1回のリクエスト料金はいくらですか？

APIリクエスト1回につき$0.002です。同じ決定的な生成器をブラウザ内でも実行できます。

Shields画像を利用できるか確認しますか？

いいえ。ネットワーク要求や画像の取得を行わず、URLとMarkdownだけを生成します。

16進数の色を使用できますか？

はい。RGBの16進値は先頭のハッシュ記号の有無を問わず指定でき、生成パスではその記号を省きます。

URL内のハイフンやアンダースコアを2個にするのはなぜですか？

Shieldsが、入力中の文字をパス区切りやエンコードされた空白と区別するためです。

ラベルまたはメッセージが空の場合はどうなりますか？

意味がありアクセシブルなバッジには両方が必要なため、無効な入力としてリクエストが失敗します。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/dev/readme-badge-markdown

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/dev/readme-badge-markdown \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"build","message":"passing","color":"brightgreen"}'

const res = await fetch("https://api.kit.forhosting.com/dev/readme-badge-markdown", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "label": "build",
    "message": "passing",
    "color": "brightgreen"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/dev/readme-badge-markdown",
    headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
    json={
    "label": "build",
    "message": "passing",
    "color": "brightgreen"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev/readme-badge-markdown", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => '{"label":"build","message":"passing","color":"brightgreen"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"label":"build","message":"passing","color":"brightgreen"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev/readme-badge-markdown", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "label": "build",
  "message": "passing",
  "color": "brightgreen"
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "dev.readme_badge_markdown",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.002

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。

KITの完全なドキュメントを見る →