المطورون / Tools

معاينة استيراد OpenAPI

POST https://api.echonova.ai/v1/tools/openapi/preview

يقرأ مستند OpenAPI، مضمَّنًا أو من عنوان URL عام، ويسرد العمليات التي ستستوردها الأداة. لا يُحفظ شيء. الحد الأقصى 5 استدعاءات في الدقيقة لكل مفتاح. الخدمة مجانية. يحتاج المفتاح إلى النطاق `tools:write`.

Headers

Authorization string مطلوب

كلمة ⁦Bearer⁩ ثم مسافة ثم مفتاح ⁦API⁩ الذي يبدأ بـ ⁦ek_⁩. أنشئ المفاتيح في البوابة من المطورون، ثم مفاتيح واجهة برمجة التطبيقات.

متن الطلب

application/json

spec object اختياري

مستند OpenAPI بصيغة JSON، بحجم يصل إلى 5 ميغابايت. أرسل واحدًا فقط من `spec` أو `url`.

url string اختياري

عنوان URL عام بروتوكول https لمستند OpenAPI. أرسل واحدًا فقط من `spec` أو `url`.

حتى 2000 حرفًا
baseUrlOverride string اختياري

الخادم الذي تستدعيه الأداة، ويحل محل خوادم المستند. مطلوب عند الإنشاء.

حتى 2000 حرفًا

الاستجابة

200 application/json كل استجابة تستخدم هذا الغلاف.

data object

النتيجة.

success boolean

قيمته ⁦true⁩ عند نجاح الطلب.

statusCode integer

يكرر رمز حالة ⁦HTTP⁩.

errorMessage string or null

قيمته ⁦null⁩ عند النجاح.

الأخطاء

الغلاف نفسه، مع ⁦success⁩ بقيمة ⁦false⁩ و ⁦data⁩ بقيمة ⁦null⁩. كل الأخطاء

POST /v1/tools/openapi/preview

curl -X POST "https://api.echonova.ai/v1/tools/openapi/preview" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "data": {
    "apiTitle": "Orders API",
    "operationCount": 12,
    "warnings": [
      "Skipped 2 operations without an operationId"
    ],
    "baseUrl": "https://api.example.com",
    "operations": [
      {
        "name": "getOrder",
        "method": "GET",
        "path": "/orders/{orderId}",
        "description": "Find an order.",
        "mutating": false,
        "parameters": [
          {
            "name": "orderId",
            "location": "path",
            "required": true,
            "type": "string"
          }
        ],
        "bodyFields": [
          {
            "name": "quantity",
            "type": "integer",
            "required": false
          }
        ]
      }
    ]
  },
  "success": true,
  "statusCode": 200,
  "errorMessage": null
}