nswag.json

nswag configuration

Type object
File match nswag.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/nswag-json/latest.json
Source https://www.schemastore.org/nswag.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

swaggerGenerator object
1 nested properties
webApiToSwagger object
15 nested properties
assemblyPaths string[]
referencePaths string[]
useNuGetCache boolean
isAspNetCore boolean
controllerNames string[]
defaultUrlTemplate string
defaultPropertyNameHandling string
Values: "Default" "CamelCase" "SnakeCase"
defaultEnumHandling string
Values: "Integer" "String" "CamelCaseString"
flattenInheritanceHierarchy boolean
generateKnownTypes boolean
generateXmlObjects boolean
addMissingPathParameters boolean
infoTitle string
infoVersion string
output null
codeGenerators object
3 nested properties
swaggerToTypeScriptClient object
All of: clientGenerator object
21 nested properties
template string
Values: "JQueryCallbacks" "JQueryPromises" "AngularJS" "Angular" "Fetch" "Aurelia"
promiseType string
Values: "Promise" "QPromise"
wrapDtoExceptions boolean
clientBaseClass string
configurationClass string
useTransformOptionsMethod boolean
useTransformResultMethod boolean
baseUrlTokenName string
protectedMethods string[]
importRequiredTypes boolean
useGetBaseUrlMethod boolean
queryNullValue string
httpClass string
Values: "Http" "HttpClient"
rxJsVersion number
useSingletonProvider boolean
injectionTokenType string
Values: "OpaqueToken" "InjectionToken"
markOptionalProperties boolean
typeScriptVersion number
moduleName string
nullValue string
typeStyle string
Values: "Interface" "Class" "KnockoutClass"
swaggerToCSharpClient object
All of: clientGenerator object
swaggerToCSharpController

Definitions

swaggerGenerator object
webApiToSwagger object
15 nested properties
assemblyPaths string[]
referencePaths string[]
useNuGetCache boolean
isAspNetCore boolean
controllerNames string[]
defaultUrlTemplate string
defaultPropertyNameHandling string
Values: "Default" "CamelCase" "SnakeCase"
defaultEnumHandling string
Values: "Integer" "String" "CamelCaseString"
flattenInheritanceHierarchy boolean
generateKnownTypes boolean
generateXmlObjects boolean
addMissingPathParameters boolean
infoTitle string
infoVersion string
output null
codeGenerators object
swaggerToTypeScriptClient object
All of: clientGenerator object
21 nested properties
template string
Values: "JQueryCallbacks" "JQueryPromises" "AngularJS" "Angular" "Fetch" "Aurelia"
promiseType string
Values: "Promise" "QPromise"
wrapDtoExceptions boolean
clientBaseClass string
configurationClass string
useTransformOptionsMethod boolean
useTransformResultMethod boolean
baseUrlTokenName string
protectedMethods string[]
importRequiredTypes boolean
useGetBaseUrlMethod boolean
queryNullValue string
httpClass string
Values: "Http" "HttpClient"
rxJsVersion number
useSingletonProvider boolean
injectionTokenType string
Values: "OpaqueToken" "InjectionToken"
markOptionalProperties boolean
typeScriptVersion number
moduleName string
nullValue string
typeStyle string
Values: "Interface" "Class" "KnockoutClass"
swaggerToCSharpClient object
All of: clientGenerator object
swaggerToCSharpController
webApiToSwagger object
assemblyPaths string[]
referencePaths string[]
useNuGetCache boolean
isAspNetCore boolean
controllerNames string[]
defaultUrlTemplate string
defaultPropertyNameHandling string
Values: "Default" "CamelCase" "SnakeCase"
defaultEnumHandling string
Values: "Integer" "String" "CamelCaseString"
flattenInheritanceHierarchy boolean
generateKnownTypes boolean
generateXmlObjects boolean
addMissingPathParameters boolean
infoTitle string
infoVersion string
output null
clientGenerator object
namespace string
dateTimeType string
wrapDtoExceptions boolean
operationGenerationMode string
Values: "MultipleClientsFromOperationId" "MultipleClientsFromPathSegments" "SingleClientFromOperationId" "SingleClientFromPathSegments"
generateCloneMethod boolean
generateDefaultValues boolean
excludedTypeNames string[]
handleReferences boolean
generateConstructorInterface boolean
importRequiredTypes string
baseUrlTokenName string
output
className string
generateDtoTypes boolean
generateClientInterfaces boolean
generateClientClasses boolean
generateOptionalParameters boolean
wrapResponses boolean
wrapResponseMethods string[]
generateResponseClasses boolean
responseClass string
swaggerToCSharpClient object
swaggerToTypeScriptClient object
template string
Values: "JQueryCallbacks" "JQueryPromises" "AngularJS" "Angular" "Fetch" "Aurelia"
promiseType string
Values: "Promise" "QPromise"
wrapDtoExceptions boolean
clientBaseClass string
configurationClass string
useTransformOptionsMethod boolean
useTransformResultMethod boolean
baseUrlTokenName string
protectedMethods string[]
importRequiredTypes boolean
useGetBaseUrlMethod boolean
queryNullValue string
httpClass string
Values: "Http" "HttpClient"
rxJsVersion number
useSingletonProvider boolean
injectionTokenType string
Values: "OpaqueToken" "InjectionToken"
markOptionalProperties boolean
typeScriptVersion number
moduleName string
nullValue string
typeStyle string
Values: "Interface" "Class" "KnockoutClass"
swaggerToCSharpController