tsoa-next / @tsoa-next/cli / ExtendedSpecConfig

इंटरफ़ेस: विस्तारितस्पेक्टकॉनफिग

में परिभाषित: cli/src/api.ts:387

सामान्यीकृत कल्पना-पीढ़ी विन्यास द्वारा वापस लौटे validateSpecConfig।

विस्तार

• SpecConfig

गुण

basePath?

optional basePath?: string;

में परिभाषित: packages/runtime/src/config.ts:163

बेस एपीआई पथ; उदाहरण के लिए 'v1' में https://myapi.com/v1

से विरासत

SpecConfig.basePath

---

contact?

optional contact?: object;

में परिभाषित: packages/runtime/src/config.ts:135

प्रकाशित एपीआई के लिए संपर्क जानकारी।

email?

optional email?: string;

संपर्क व्यक्ति/संगठन का ईमेल पता।

Default

npm package author email

name?

optional name?: string;

संपर्क व्यक्ति / संगठन के नाम की पहचान करना।

Default

npm package author

url?

optional url?: string;

यूआरएल संपर्क जानकारी को इंगित करता है।

Default

npm package author url

से विरासत

SpecConfig.contact

---

controllerPathGlobs?

optional controllerPathGlobs?: string[];

में परिभाषित: cli/src/api.ts:390

---

description?

optional description?: string;

में परिभाषित: packages/runtime/src/config.ts:124

एपीआई विवरण; डिफ़ॉल्ट करने के लिए npm पैकेज विवरण

से विरासत

SpecConfig.description

---

disableBasePathPrefixSlash?

optional disableBasePathPrefixSlash?: boolean;

में परिभाषित: packages/runtime/src/config.ts:170

नियंत्रण basePath के साथ prefixed है / जब रचना OpenAPI 3 सर्वर यूआरएल।

केवल कल्पना संस्करण 3 या 3.1 के साथ उपलब्ध है।

से विरासत

SpecConfig.disableBasePathPrefixSlash

---

entryFile

entryFile: string;

में परिभाषित: cli/src/api.ts:388

---

host?

optional host?: string;

में परिभाषित: packages/runtime/src/config.ts:88

एपीआई होस्ट का नाम Swagger उदाहरण के लिए, 2 आउटपुट localhost:3000।

से विरासत

SpecConfig.host

---

license?

optional license?: string;

में परिभाषित: packages/runtime/src/config.ts:158

एपीआई लाइसेंस; डिफ़ॉल्ट to npm प्रस्तुत करते समय पैकेज लाइसेंस

से विरासत

SpecConfig.license

---

name?

optional name?: string;

में परिभाषित: packages/runtime/src/config.ts:119

एपीआई नाम; डिफ़ॉल्ट करने के लिए npm पैकेज का नाम

से विरासत

SpecConfig.name

---

noImplicitAdditionalProperties

noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";

में परिभाषित: cli/src/api.ts:389

---

operationIdTemplate?

optional operationIdTemplate?: string;

में परिभाषित: packages/runtime/src/config.ts:197

संचालन आईडी उत्पन्न करने के लिए टेम्पलेट स्ट्रिंग। यह एक वैध हैंडलबार टेम्पलेट होना चाहिए और प्रदान किया जाता है निम्नलिखित संदर्भ के साथ:

• नियंत्रक नाम' - नियंत्रक वर्ग का स्ट्रिंग नाम।
• 'method' - Tsoa। विधि वस्तु।

Default

'{{titleCase method.name}}'

से विरासत

SpecConfig.operationIdTemplate

---

outputDirectory

outputDirectory: string;

में परिभाषित: packages/runtime/src/config.ts:83

निर्देशिका जहां उत्पन्न कल्पना फ़ाइल लिखा जाना चाहिए।

से विरासत

SpecConfig.outputDirectory

---

rootSecurity?

optional rootSecurity?: Security[];

में परिभाषित: packages/runtime/src/config.ts:232

पूरे एपीआई को डिफ़ॉल्ट सुरक्षा प्रदान करता है। ओवरराइड किया जा सकता है @Security(...) या @NoSecurity() नियंत्रकों या विधियों पर सजावटकर्ता।

से विरासत

SpecConfig.rootSecurity

---

schemes?

optional schemes?: Protocol[];

में परिभाषित: packages/runtime/src/config.ts:215

समर्थित प्रोटोकॉल Swagger 2 आउटपुट।

से विरासत

SpecConfig.schemes

---

securityDefinitions?

optional securityDefinitions?: object;

में परिभाषित: packages/runtime/src/config.ts:202

विनिर्देशन के लिए घोषित सुरक्षा योजनाएं।

सूचकांक हस्ताक्षर

[name: string]: SecuritySchemes

से विरासत

SpecConfig.securityDefinitions

---

servers?

optional servers?: string[];

में परिभाषित: packages/runtime/src/config.ts:95

सर्वर यूआरएल के लिए OpenAPI 3 आउटपुट।

केवल कल्पना संस्करण 3 या 3.1 के साथ उपलब्ध है।

से विरासत

SpecConfig.servers

---

spec?

optional spec?: unknown;

में परिभाषित: packages/runtime/src/config.ts:176

ऑब्जेक्ट उत्पन्न स्पेक में विलय हो गया। उत्पन्न गुण हमेशा यहां दिए गए मूल्यों पर प्राथमिकता लेते हैं।

से विरासत

SpecConfig.spec

---

specFileBaseName?

optional specFileBaseName?: string;

में परिभाषित: packages/runtime/src/config.ts:102

स्वैगर का आधार नाम। जेसन या स्वैगर। yaml.

@default: "swagger"

से विरासत

SpecConfig.specFileBaseName

---

specMerging?

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

में परिभाषित: packages/runtime/src/config.ts:186

कैसे नियंत्रित करें spec उत्पन्न दस्तावेज़ में विलय हो जाता है। संभव मान:

• 'immediate' केवल शीर्ष स्तर तत्वों को ओवरराइड करता है।
• 'recursive' एक गहरी विलय का उपयोग करता है merge।
• 'deepmerge' एक गहरी विलय का उपयोग करता है ts-deepmerge, सरणी सहित।

Default

'immediate'

से विरासत

SpecConfig.specMerging

---

specVersion?

optional specVersion?: SupportedSpecMajorVersion;

में परिभाषित: packages/runtime/src/config.ts:114

प्रमुख OpenAPI उत्पन्न करने के लिए संस्करण; जब निर्दिष्ट नहीं किया गया तो संस्करण 2 में डिफ़ॉल्ट संभव मान:

• 2: उत्पन्न करना OpenAPI संस्करण 2.
• 3: उत्पन्न OpenAPI संस्करण 3.
• 3.1: उत्पन्न OpenAPI संस्करण 3.1.

से विरासत

SpecConfig.specVersion

---

tags?

optional tags?: Tag[];

में परिभाषित: packages/runtime/src/config.ts:209

उत्पन्न विनिर्देश के लिए शीर्ष स्तर के टैग मेटाडाटा।

से विरासत

SpecConfig.tags

---

termsOfService?

optional termsOfService?: string;

में परिभाषित: packages/runtime/src/config.ts:130

उस पृष्ठ से लिंक करें जो सेवा की शर्तों का वर्णन करता है। यूआरएल प्रारूप में होना चाहिए।

से विरासत

SpecConfig.termsOfService

---

useTitleTagsForInlineObjects?

optional useTitleTagsForInlineObjects?: boolean;

में परिभाषित: packages/runtime/src/config.ts:226

क्लाइंट जनरेशन में सुधार के लिए इनलाइन प्रतिक्रिया और अनुरोध-बॉडी ऑब्जेक्ट स्कीमा के लिए शीर्षक जोड़ता है।

से विरासत

SpecConfig.useTitleTagsForInlineObjects

---

version?

optional version?: string;

में परिभाषित: packages/runtime/src/config.ts:105

एपीआई संस्करण संख्या; पैकेज संस्करण के लिए डिफ़ॉल्ट।

से विरासत

SpecConfig.version

---

xEnumVarnames?

optional xEnumVarnames?: boolean;

में परिभाषित: packages/runtime/src/config.ts:221

X-enum-varname समर्थन सक्षम करें

Default

false

से विरासत

SpecConfig.xEnumVarnames

---

yaml?

optional yaml?: boolean;

में परिभाषित: packages/runtime/src/config.ts:212

JSON के बजाय YAML के रूप में उत्पन्न ऐनक को लिखते हैं।

से विरासत

SpecConfig.yaml

Contributors

No contributors

Changelog

No recent changes