i-swagger-build-definition.md

ISwaggerBuildDefinition

setBasePath: string

Define base URL for all API.

• Optional.
• Default is "/"

setOpenapi: string

Define version of OpenAPI.

• Optional.

setInfo : SwaggerInfo

Define setInfo.

setConsumes: string[]

Define the MIME types supported by the API for setConsumes. The root-level definition can be overridden in individual operations.

• Optional
• Default is SwaggerDefinition.Consume.JSON or "application/json".

setProduces: string[]

Define the MIME types supported by the API for setProduces. The root-level definition can be overridden in individual operations.

• Optional
• Default is SwaggerDefinition.Consume.JSON or "application/json".

setSchemes: string[]

Define Schemes.

• Optional
• Default is SwaggerDefinition.Scheme.HTTP = "http"

setHost: string

Define setHost.

• Optional

models: {[key: string]: ISwaggerBuildDefinitionModel}

Define all model.

• Required

externalDocs: ISwaggerExternalDocs

Define external docs

• Optional

securityDefinitions: {[key: string]: ISwaggerSecurityDefinition}

Define security definitions

• Optional

responses: {[key: string]: IApiOperationArgsBaseResponse}

Define global responses

• Optional