التمثيل المنظَّم لإعلان الدالة على النحو المحدّد في مواصفات OpenAPI 3.0 يتضمّن هذا التعريف اسم الدالة والمَعلمات. تمثّل FunctionDeclaration هذه مجموعة من الرموز البرمجية يمكن استخدامها كأداة من خلال النموذج وتنفيذها العميل.
Signature:
export declare interface FunctionDeclaration
أماكن إقامة
| الموقع | Type | الوصف |
|---|---|---|
| description | سلسلة | هذه السمة اختيارية. وصف الدالة والغرض منها. ويستخدمه النموذج لتحديد كيفية استدعاء الدالة وما إذا كان سيتم استدعاءها. |
| name | سلسلة | اسم الدالة المطلوب استدعاءها. يجب أن يبدأ بحرف أو شرطة سفلية. يجب أن تكون القيمة a-z أو A-Z أو 0-9 أو أن تحتوي على شرطات سفلية وشرطات، على أن يبلغ طولها 64 كحد أقصى. |
| المَعلمات | FunctionDeclarationSchema | هذه السمة اختيارية. تصف المعلمات لهذه الدالة بتنسيق كائن مخطط JSON. يعكس كائن المعلَمة 3.03 في واجهة برمجة التطبيقات المفتوحة. أسماء المَعلمات حسّاسة لحالة الأحرف. بالنسبة إلى أيّ دالة لا تتضمّن مَعلمات، يمكن ترك هذا الخيار بدون ضبط. |
FunctionDeclaration.description
هذه السمة اختيارية. وصف الدالة والغرض منها. ويستخدمه النموذج لتحديد كيفية استدعاء الدالة وما إذا كان سيتم استدعاءها.
Signature:
description?: string;
FunctionDeclaration.name
اسم الدالة المطلوب استدعاءها. يجب أن يبدأ بحرف أو شرطة سفلية. يجب أن تكون القيمة a-z أو A-Z أو 0-9 أو أن تحتوي على شرطات سفلية وشرطات، على أن يبلغ طولها 64 كحد أقصى.
Signature:
name: string;
FunctionDeclaration.parameters
هذه السمة اختيارية. تصف المعلمات لهذه الدالة بتنسيق كائن مخطط JSON. يعكس كائن المعلَمة 3.03 في واجهة برمجة التطبيقات المفتوحة. أسماء المَعلمات حسّاسة لحالة الأحرف. بالنسبة إلى أيّ دالة لا تتضمّن مَعلمات، يمكن ترك هذا الخيار بدون ضبط.
Signature:
parameters?: FunctionDeclarationSchema;