← بازگشت به فهرست ATP
صفحات وب

صفحه اصلی سرویس (GET /)

GET / مشاهده در Swagger

ATP - صفحه اصلی سرویس (GET /)

Endpoint

GET /

هدف آزمون

نمایش صفحه فرود فارسی با لینک‌های سریع به health، معماری، ATP و Swagger.

شرایط آزمون

فرآیند آزمون

  1. ارسال درخواست GET به /
  2. دریافت پاسخ HTML با Content-Type: text/html
  3. بررسی عنوان، lead و کارت‌های لینک

معرفی ویژگی

صفحه فرود داخلی سرویس استخراج اطلاعات. نقطه ورود tester و توسعه‌دهنده برای دسترسی به مستندات ATP، معماری زنده و endpointهای HTTP است.

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

سناریو 1: مسیر موفق — صفحه با لینک‌های کامل

  1. اجرای سرویس با APP_ENV=local
  2. ارسال GET /
  3. دریافت کد 200 و Content-Type شامل text/html
  4. بررسی وجود «مشاهده معماری»، «مشاهده فهرست ATP» و /architecture/

سناریو 2: Swagger غیرفعال در production

  1. اجرای سرویس با APP_ENV=docker و ENABLE_API_DOCS=false
  2. ارسال GET /
  3. دریافت کد 200
  4. بررسی نبود لینک Open Swagger UI در HTML

قالب API

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

Swagger

get:
  summary: HTML landing page (not in OpenAPI)
  responses:
    200:
      description: HTML page returned

نمونه ورودی

curl -X GET "http://127.0.0.1:8000/" \
  -H "Accept: text/html"

نمونه خروجی

<!-- Content-Type: text/html; charset=utf-8 -->
<h1>استخراج متن اسناد برای پرونده‌های اختراع</h1>
<a href="/architecture/">مشاهده معماری</a>
<a href="/atp/">مشاهده فهرست ATP</a>
<a href="/api/v1/health">GET /api/v1/health</a>

Status Codes

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

پاسخ HTML فارسی با لینک‌های health، architecture، ATP و در صورت فعال بودن Swagger.

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

  1. بررسی کد 200
  2. بررسی Content-Type شامل text/html
  3. بررسی وجود /architecture/ و /atp/ در HTML
  4. در local، بررسی وجود لینک Swagger

توضیحات