Ping API

サーバーの死活確認用エンドポイントです。

---

GET /v1/ping

概要

サーバーの死活確認用エンドポイントです。

リクエストとレスポンス

ヘッダー

リクエストヘッダー

なし

レスポンスヘッダー

• Content-Type: application/json

URI

/v1/ping

リクエストボディ

なし

レスポンス

レスポンスはJSONです。

{
  "message": "pong"
}

認証

このエンドポイントは認証不要です。

例外処理

説明	ステータスコード	ステータス名
内部サーバーエラー	500	Internal Server Error

処理フロー

1. リクエストを受信する
2. { "message": "pong" } を返す

詳細フローチャート

flowchart TD
    Start([GET /v1/ping]) --> Route[Route Handler]
    Route --> Success[200 OK<br/>pong]

---

GET /v1/ping/deep

概要

サーバーおよびDBの死活確認用エンドポイントです。

リクエストとレスポンス

ヘッダー

リクエストヘッダー

なし

レスポンスヘッダー

• Content-Type: application/json

URI

GET /v1/ping/deep

リクエストボディ

なし

レスポンス

レスポンスはJSONです。

200 OK

{
  "message": "pong",
  "db": "ok"
}

503 Service Unavailable（DB接続失敗時）

{
  "message": "pong",
  "db": "error"
}

認証

このエンドポイントは認証不要です。

例外処理

説明	ステータスコード	ステータス名
DB への疎通に失敗	503	Service Unavailable

DB 疎通の例外は実装側で捕捉して {"message": "pong", "db": "error"} と 503 を返すため、 このエンドポイントが 500 を返すことはありません。

処理フロー

1. リクエストを受信する
2. DBへの疎通確認を行う
3. 結果を返す

flowchart TD
    Start([GET /v1/ping/deep]) --> DBCheck[DB疎通確認]
    DBCheck -->|成功| Success[200 OK<br/>db: ok]
    DBCheck -->|失敗| E503[503 Service Unavailable<br/>db: error]