الصفحة الرئيسية>كود مصدر ASP>فئات أخرى
تنزيل

عام

ملكية وصف تقصير
Routeprefix بادئة الطريق للوصول إلى Rapidoc "رابدوك"
specurl عنوان URL لمواصف Openapi لعرضه String.Empty
HeadingText عنوان العنوان على الزاوية اليسرى العليا "رابدوك"
sortags مسموح به: صحيح | خطأ شنيع
لسرد العلامات بالترتيب الأبجدي ، وإلا سيتم طلب العلامات بناءً على كيفية تحديدها ضمن قسم العلامات في المواصفات.		 خطأ شنيع
sortendpointsby مسموح: المسار | طريقة | ملخص
فرز نقاط النهاية داخل كل علامة حسب المسار أو الأسلوب أو الملخص | مثال		 طريق
غوتوباث الموقع الأولي على المستند (الذي تم تحديده بواسطة الطريقة والمسار) حيث تريد متابعة المواصفات.
على سبيل المثال ، إذا كنت ترغب في التمرير/تسجيل الدخول/تسجيل الدخول ، فيجب عليك توفير الموقع على أنه new PathInfo(SubmitMethod.Get,"/user/login")		 باطل
FillRequestfieldswithExample مسموح به: صحيح | خطأ شنيع
سيتم ملء حقول الطلب بقيمة مثال (إذا تم توفيرها في المواصفات)		 حقيقي

ألوان واجهة المستخدم وخيارات الخطوط

ملكية وصف تقصير
سمة هو الموضوع الأساسي ، الذي يستخدم لحساب الألوان لمختلف مكونات واجهة المستخدم. "السمة" و "BG-Color" و "Text-Color" هي السمات الأساسية لإنشاء سمة مخصصة مظلم
bgcolor لون الخلفية الرئيسية موضوع الظلام #333
موضوع الضوء #FFF
TextColor لون النص موضوع الظلام #BBB
موضوع الضوء #444
HeaderColor لون خلفية الرأس #444444
اللون الأساسي اللون على أدوات التحكم المختلفة مثل الأزرار ، علامات التبويب #FF791A
loadfonts سيحاول Rapidoc تحميل الخطوط من CDN ، إذا لم يكن هذا المقصود ، فقم بتعيين هذا على خطأ. حقيقي
منتظم اسم (أسماء) الخط لاستخدامه للنص العادي "Open Sans" ، Avenir ، "Segoe UI" ، Arial ، Sans-Serif
Monofont اسم (أسماء) الخط لاستخدامه في النص أحادي المسافة Monaco ، 'Andale Mono' ، 'Roboto Mono' ، 'Consolas' Monospace
الحجم يعين أحجام الخط النسبي للوثيقة بأكملها تقصير

خيارات شريط التنقل

ملكية وصف تقصير
usepathinnavbar تعيين صحيح لإظهار مسارات API في شريط التنقل بدلاً من الملخص/الوصف | مثال خطأ شنيع
NavbgColor مثال لون خلفية شريط التنقل
Navbgimage مثال على خلفية عنوان URL في شريط الملاحة String.Empty
Navbgimagesize حجم صورة خلفية شريط التنقل (مثل خاصية بحجم خلفية CSS) آلي
navbgimagerepeat تكرار صورة خلفية شريط التنقل (مثل خاصية تكرار خلفية CSS) norepeat
NavtextColor لون نص شريط التنقل لا لون
NavhoverbgColor لون خلفية عنصر التنقل على الماوس فوق لا لون
NavhovertextColor لون النص لعنصر التنقل على الماوس لا لون
Navaccentcolor مؤشر العنصر المحدد الحالي لا لون
Navitemspacing يتحكم مثال تباعد عنصر الملاحة تقصير

خيارات تخطيط واجهة المستخدم

ملكية وصف تقصير
تَخطِيط يساعد التصميم في وضع أقسام الطلب/الاستجابة. في تخطيط الأعمدة ، يتم وضع أقسام الطلب والاستجابة واحدة أسفل الأخرى ، في تصميم الصف ، يتم وضعها جنبًا إلى جنب. لا تنطبق هذه السمة إلا عندما يكون عرض الجهاز أكثر من 768 بكسل ونمط العرض هو "عرض". صف
Renderstyle يحدد عرض API-DOCs. حاليا هناك ثلاثة أوضاع مدعومة
عرض ودية للاستكشاف السريع (توسيع/انهيار قسم اهتمامك)
اقرأ مناسبة للقراءة (مثل صفحة ويب مستمرة)
ركز على غرار القراءة ولكن يركز على نقطة نهاية واحدة في وقت واحد (جيد للمواصفات الكبيرة)
اقرأ أكثر ملاءمة لقراءة عرض أكثر ودية للاستكشاف السريع		 منظر
onnavtagclick ينطبق فقط على نمط التجسيد المركز. يحدد سلوك النقر على علامة في شريط التنقل. يمكن إما توسيع نطاق العلامة أو يأخذك إلى صفحة وصف العلامة. توسيع Collapse
Schematele طريقتان مختلفتان لعرض schemas الكائنات في الردود وطلب الهيئات شجرة
Schemaexpandlevel يتم توسيع المخططات افتراضيًا ، استخدم هذه السمة للتحكم في عدد المستويات في المخطط التي يجب توسيعها 999
schemadscriptioneded يتم انهيار معلومات القيد والأوصاف عن الحقول في المخطط لإظهار السطر الأول فقط. قم بتعيينه على True إذا كنت تريد توسيعها بالكامل خطأ شنيع
schemahidereadonly يتم دائمًا إخفاء المقودات القراءة فقط في مخططات الطلب ولكن يتم عرضها رداً على ذلك.
إذا كنت لا ترغب في إخفاء حقول القراءة فقط أو إخفائها بناءً على الإجراء ، يمكنك تكوين هذا الإعداد إلى "أبدًا" أو أي مجموعة من post | ضع | تصحيح للإشارة إلى مكان الاختباء
لا تتأثر المخططات في قسم الاستجابة بهذا الإعداد.		 دائماً
Schemahidewriteonly يتم انهيار معلومات القيد والأوصاف عن الحقول في المخطط لإظهار السطر الأول فقط. قم بتعيينه على True إذا كنت تريد توسيعها بالكامل دائماً
DefaultSchematab يتم عرض المخططات في علامات تبويب - نموذج ومثال. يتيح لك هذا الخيار اختيار علامة التبويب الافتراضية التي ترغب في أن تكون نشطًا نموذج
Responseareaeight قيمة ارتفاع CSS صالحة مثل 400px ، 50 ٪ ، 60VH ، إلخ - استخدم هذه القيمة للتحكم في ارتفاع نص الاستجابة "300px"

خيارات القسم

ملكية وصف تقصير
ShowInfo عرض/إخفاء قسم معلومات المستندات
يحتوي قسم المعلومات على معلومات حول المواصفات ، مثل عنوان المواصفات ووصفها ، الإصدار ، شروط الخدمات ، إلخ. هناك احتمالات ، قد يكون لدى DOC DOC هذه المعلومات بالفعل ، في هذه الحالة قد ترغب في إخفاء هذا القسم.		 حقيقي
infodescriptionheadinginginnavbar قم بتضمين رؤوس من المعلومات -> الوصف قسم إلى شريط التنقل (ينطبق على وضع القراءة فقط)
سوف تحصل على الرؤوس من Markdown in Info - Description (H1 و H2) في القائمة على اليسار (في وضع القراءة) جنبا إلى جنب مع روابط إليهم. يتيح هذا الخيار للمستخدمين إضافة عناصر شريط التنقل باستخدام Markdown		 خطأ شنيع
ShowComponents إظهار/إخفاء قسم المكونات في كل من المستند والقائمة (متوفرة فقط في نمط العرض المركزة)
سيعرض قسم المكونات جنبًا إلى جنب مع المخططات والاستجابات والأمثلة والطلب والرؤوس والأمان والروابط والاسترجاعات ، كما سيتم عرضها في القائمة على اليسار (في وضع القراءة)		 خطأ شنيع
Showheader عرض/إخفاء الرأس.
إذا كنت لا تريد أن يفتح المستخدم أي مواصفات API أخرى ، بخلاف المواصفات الحالية ، ثم قم بتعيين هذه السمة على FALSE		 حقيقي
السماح ميزة المصادقة ، تسمح للمستخدم بتحديد إحدى آلية المصادقة المتوفرة في المواصفات. يمكن أن يكون HTTP-BASIC ، HTTP-BERER أو API-KEY. إذا كنت لا تريد أن يمر المستخدمون الخاص بك من خلال عملية المصادقة ، فليناًًًًً BSING من استخدام مفتاح API الذي تم إنشاؤه مسبقًا ، فيمكنك إخفاء قسم المصادقة عن طريق تعيين هذه السمة على FALSE وتقديم تفاصيل مفتاح API باستخدام مفتاح API مختلف-؟؟؟؟ صفات حقيقي
يسمح Pecurlload إذا تم تعيينه على "false" ، فلن يتمكن المستخدم من تحميل أي عنوان URL لمواصفات من واجهة المستخدم خطأ شنيع
يسمح PecfileLoad إذا تم تعيينه على "false" ، فلن يتمكن المستخدم من تحميل أي ملف Spec من محرك الأقراص المحلي. لا تنطبق هذه السمة إلا عندما يكون عرض الجهاز أكثر من 768 بكسل ، وإلا فإن هذه الميزة غير متوفرة خطأ شنيع
يسمح للبحث يوفر تصفية سريعة لواجهة برمجة التطبيقات حقيقي
السماح للبحث يوفر وظائف البحث المتقدمة ، للبحث من خلال مسارات API و API-Description و API-Parameters و API-Reponseses حقيقي
السماح تتيح لك ميزة "Try" إجراء مكالمات REST إلى خادم API. لتعطيل هذه الميزة ، اضبطها على خطأ. حقيقي
يتيح لـ " إذا تم تعيينه على "FALSE" ، فلن يتمكن المستخدم من رؤية أو تحديد خادم API (سيتم إخفاء قائمة الخادم ، ومع ذلك ، سيتمكن المستخدمون من رؤية عنوان URL للخادم بالقرب من زر "Try" ، لمعرفة مسبقًا أين سترسل المحاولة الطلب). سيتم استخدام عنوان URL المحدد في سمة Server-URL إذا تم تعيينه ، وإلا سيتم استخدام الخادم الأول في ملف مواصفات API. حقيقي
يسمح CHEMEDSCIPTIONEXPANDTOGGLE السماح أو إخفاء القدرة على توسيع/انهيار أوصاف الحقل في المخطط حقيقي

خيارات خادم API

ملكية وصف تقصير
Serverurl يحتوي OpenAPI Spec على حكم لتوفير عنوان URL الخادم. ستقوم واجهة المستخدم بإدراج جميع عناوين URL الخادم المتوفرة في المواصفات. يمكن للمستخدم بعد ذلك تحديد عنوان URL واحد يعتزم إرسال مكالمات API إليه أثناء تجربة واجهات برمجة التطبيقات. ومع ذلك ، إذا كنت ترغب في توفير خادم API الخاص بك والذي لم يتم سرده في المواصفات ، فيمكنك استخدام هذه الخاصية لتقديم واحدة. إنه مفيد في الحالات التي يتم فيها مشاركة المواصفات نفسها بين بيئة متعددة يقول Dev واختبار كل منها لها خادم API الخاص به. String.Empty
DefaultApiserver إذا كان لديك عدة خادم API مدرج في المواصفات ، فاستخدم هذه السمة لتحديد خادم API الافتراضي ، حيث سيتم الحصول على جميع مكالمات API. يمكن تغيير هذا لاحقًا من واجهة المستخدم String.Empty
apikeyname اسم مفتاح API الذي سيتم إرساله أثناء تجربة واجهات برمجة التطبيقات String.Empty
Apikeylocation يحدد كيف تريد إرسال مفتاح API لم يتم تعيينه
apikeyvalue قيمة مفتاح API الذي سيتم إرساله أثناء تجربة واجهات برمجة التطبيقات. يمكن أيضًا تقديم هذا/مكتوبة من واجهة المستخدم String.Empty
fetchcredentials يتيح تمرير بيانات الاعتماد/ملفات تعريف الارتباط في مكالمات النطاق المتقاطع ، على النحو المحدد في معيار الجلب ، في طلبات CORS التي يتم إرسالها بواسطة المتصفح لم يتم تعيينه

خيارات فتحات

ملكية وصف تقصير
شعار يحل محل الشعار الافتراضي للرأس مع عنوان URL المحدد String.Empty
لوجوديث يحدد عرض الشعار للشعار المخصص ، لا ينطبق على الشعار الافتراضي 36
شعار يحدد ارتفاع شعار الشعار المخصص ، لا ينطبق على الشعار الافتراضي 36
logopadding يحدد حشوة الشعار للشعار المخصص ، لا ينطبق على الشعار الافتراضي 0
نافلوغو يضيف شعار التنقل في أعلى شريط التنقل الجانبي مع عنوان URL المتوفر فقط في وضع القراءة String.Empty
navlogowidth يحدد عرض شعار التنقل للشعار المخصص ، متوفر فقط في وضع القراءة 36
Navlogoheight يحدد ارتفاع شعار التنقل للشعار المخصص ، متوفر فقط في وضع القراءة 36
Navlogopadding يحدد حشوة شعار التنقل للشعار المخصص ، متوفر فقط في وضع القراءة 0
يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل