Patent Genie — استخراج اطلاعات
← بازگشت به فهرست ATP
سلامت سرویس

بررسی سلامت سرویس (GET /health)

GET /health مشاهده در Swagger

ATP - بررسی سلامت سرویس (GET /health)

Endpoint

GET /health

هدف آزمون

بررسی وضعیت سرویس استخراج و دسترسی به RabbitMQ و object storage.

شرایط آزمون

فرآیند آزمون

  1. ارسال درخواست GET به /health
  2. دریافت پاسخ JSON
  3. بررسی فیلدهای status، service، rabbitmq و object_storage

معرفی ویژگی

endpoint سلامت برای probeهای Docker/Kubernetes و مانیتورینگ عملیاتی. وضعیت وابستگی‌های RabbitMQ و object storage را گزارش می‌کند.

سناریوی آزمون

سناریو 1: مسیر موفق — سرویس و وابستگی‌ها سالم

  1. ارسال GET /health
  2. دریافت کد 200
  3. بررسی status: "ok" و service: "patent-genie-ai"
  4. بررسی عدم پیشوند error: در rabbitmq و object_storage

سناریو 2: خطا — وابستگی در دسترس نیست

  1. قطع اتصال RabbitMQ یا object storage
  2. ارسال GET /health
  3. دریافت کد 200 با status: "degraded"
  4. بررسی مقدار error: در فیلد وابستگی ناموفق

قالب API

مولفه نوع نوع داده اجباری توضیحات
— — — — بدون پارامتر ورودی

Swagger

get:
  summary: Health check with dependency status
  responses:
    200:
      description: Service status returned

نمونه ورودی

curl -X GET "http://127.0.0.1:8000/health" \
  -H "Accept: application/json"

نمونه خروجی

{
  "status": "ok",
  "service": "patent-genie-ai",
  "rabbitmq": "connected",
  "object_storage": "reachable"
}

Status Codes

نتیجه مورد انتظار

پاسخ JSON با فیلدهای status، service، rabbitmq و object_storage و کد HTTP 200. در صورت خطای وابستگی، status برابر degraded است.

روال صحت‌سنجی

  1. بررسی کد وضعیت 200
  2. بررسی فیلد service برابر "patent-genie-ai"
  3. بررسی وجود فیلدهای rabbitmq و object_storage
  4. در محیط سالم، status باید ok باشد

توضیحات