本文へスキップ

GET /api/ping

軽量なヘルスチェック用エンドポイントです。Function Appが稼働していれば、小さなJSONボディとともに 200 を返します。認証ヘッダーは不要なので、稼働監視やCIのスモークテストに使えます。

リクエスト

レスポンス

{
  "status": "ok",
  "service": "qr-branding",
  "version": "1.6.2",
  "now": "2026-05-24T08:14:31Z"
}
  • status — 関数が実行されれば常に "ok" です。実行されなかった場合は、JSONボディではなく接続エラーになります。
  • version — デプロイされているエンジンのセマンティックバージョン。
  • now — UTCのサーバー時刻。X-Internal-Ts 署名がずれていないかの確認に便利です。

ユースケース

  • 稼働監視: 60秒ごとに /api/ping を呼び出し、200以外ならアラートを出します。
  • CIのスモークテスト: デプロイのたびに、version がプッシュしたタグと一致しなければパイプラインを失敗させます。
  • 時刻ずれの確認: 内部BFFからの 401 INVALID_SIGNATURE をデバッグするときに、now とクライアントの時刻を比較します(TTLは60秒。90秒を超えるずれがあるとHMACが失敗します)。

チェックしないこと

pingは意図的に軽量にしています。次の点は検証しません。

  • データベースに到達できるか。
  • LLMプロバイダーが応答するか。
  • RapidAPI / 内部の認証ヘッダーが正しく設定されているか。

より詳しく確認するには、最小限のペイロード(content のみ)で /api/qr/generate を呼び出し、QRが返ってくることを確認してください。