tsoa-next / tsoa-next / SpecConfig

Interface: SpecConfig

محددة في: packages/runtime/src/config.ts:79

OpenAPI أجيال

الممتلكات

basePath?

optional basePath?: string;

محددة في: packages/runtime/src/config.ts:163

طريق الـ "بي آي" في القاعدة، مثل "إف 1" https://myapi.com/v1

---

contact?

optional contact?: object;

محددة في: packages/runtime/src/config.ts:135

Contact information for the published API.

email?

optional email?: string;

عنوان البريد الإلكتروني لشخص/تنظيم الاتصال.

Default

npm package author email

name?

optional name?: string;

The identifying name of the contact person/organization.

Default

npm package author

url?

optional url?: string;

URL pointing to the contact information.

Default

npm package author url

---

description?

optional description?: string;

محددة في: packages/runtime/src/config.ts:124

وصف طلب الموافقة المسبقة عن علم؛ npm وصف

---

disableBasePathPrefixSlash?

optional disableBasePathPrefixSlash?: boolean;

محددة في: packages/runtime/src/config.ts:170

الضوابط على ما إذا كانت basePath تم تحديدها مسبقاً / عند تكوينها OpenAPI 3 خوادم

فقط متاحة بنسخة 3 أو 3-1.

---

host?

optional host?: string;

محددة في: packages/runtime/src/config.ts:88

اسم البلد المضيف Swagger ناتجان على سبيل المثال localhost:3000.

---

license?

optional license?: string;

محددة في: packages/runtime/src/config.ts:158

رخصـة الرخصـة المرفـقـة؛ npm حزمة ترخيص عند وجودها

---

name?

optional name?: string;

محددة في: packages/runtime/src/config.ts:119

اسم API؛ التقصير إلى npm الاسم

---

operationIdTemplate?

optional operationIdTemplate?: string;

محددة في: packages/runtime/src/config.ts:197

سلسلة نموذجية لتوليد العمليات This should be a valid handlebars template and is provided مع السياق التالي:

• راكب اسم "سترينج" لفصل المتحكمين
• تسو هدف مُحدّد.

Default

'{{titleCase method.name}}'

---

outputDirectory

outputDirectory: string;

محددة في: packages/runtime/src/config.ts:83

دليل أين يجب أن يكتب ملف المواصفات

---

rootSecurity?

optional rootSecurity?: Security[];

محددة في: packages/runtime/src/config.ts:232

يُطبّقُ أمناً خاطئاً إلى كامل مكتب التحقيقات الفدرالي. يمكن أن تكون مغمورة @Security(...) أو @NoSecurity() مصممون على أجهزة التحكم أو الأساليب

---

schemes?

optional schemes?: Protocol[];

محددة في: packages/runtime/src/config.ts:215

البروتوكولات الداعمة Swagger ناتجان.

---

securityDefinitions?

optional securityDefinitions?: object;

محددة في: packages/runtime/src/config.ts:202

مخططات الأمن المعلنة للمواصفات.

مؤشر التوقيع

[name: string]: SecuritySchemes

---

servers?

optional servers?: string[];

محددة في: packages/runtime/src/config.ts:95

خادم OpenAPI 3 ناتج

فقط متاحة بنسخة 3 أو 3-1.

---

spec?

optional spec?: unknown;

محددة في: packages/runtime/src/config.ts:176

اخترقت المواصفات المتولدة وتتمتع الممتلكات المولدة دائما بالأسبقية على القيم المقدمة هنا.

---

specFileBaseName?

optional specFileBaseName?: string;

محددة في: packages/runtime/src/config.ts:102

لقب (سواغر) (جيسون) أو (سواغر) يامل

@default: "سواغر"

---

specMerging?

optional specMerging?: "recursive" | "immediate" | "deepmerge";

محددة في: packages/runtime/src/config.ts:186

التحكم كيف spec يتم دمجه في الوثيقة المتولدة القيم المحتملة:

• 'مسرعة تجاوزات فقط العناصر العليا.
• "التكرار يؤدي دوراً عميقاً" merge.
• (ديبميرج) يقوم بدمج عميق ts-deepmergeبما في ذلك الصفوف

Default

'immediate'

---

specVersion?

optional specVersion?: SupportedSpecMajorVersion;

محددة في: packages/runtime/src/config.ts:114

الرائد OpenAPI إصدارات لتوليدها؛ تقصير في الصيغة 2 عندما لا يحدد القيم المحتملة:

• 2 - المولدات OpenAPI نسخة 2.
• 3 - المولدات OpenAPI نسخة 3
• 3-1: المولدات OpenAPI الصيغة 3-1.

---

tags?

optional tags?: Tag[];

محددة في: packages/runtime/src/config.ts:209

البيانات الوصفية على المستوى الرفيع للمواصفات المتولدة.

---

termsOfService?

optional termsOfService?: string;

محددة في: packages/runtime/src/config.ts:130

ربط الصفحة التي تصف شروط الخدمة. يجب أن يكون في شكل URL.

---

useTitleTagsForInlineObjects?

optional useTitleTagsForInlineObjects?: boolean;

محددة في: packages/runtime/src/config.ts:226

يضاف عناوين للرد الخطي وخصائص الجسم الطلبي لتحسين توليد العملاء.

---

version?

optional version?: string;

محددة في: packages/runtime/src/config.ts:105

نسخة من نظام المعلومات الإدارية المتكامل؛ التقصير في صيغة الطرد.

---

xEnumVarnames?

optional xEnumVarnames?: boolean;

محددة في: packages/runtime/src/config.ts:221

الدعم الممكّن من استخدام الأسماء من الفئة " X-enum "

Default

false

---

yaml?

optional yaml?: boolean;

محددة في: packages/runtime/src/config.ts:212

يكتب المواصفات المتولدة كـ(يام إل) بدلاً من (جيون)

Contributors

No contributors

Changelog

No recent changes