Class SwaggerInputProcessor

Class for processing Swagger inputs

Hierarchy (view full)

AbstractInputProcessor
- SwaggerInputProcessor

Index

Constructors

constructor

new SwaggerInputProcessor(): SwaggerInputProcessor
Returns SwaggerInputProcessor
Inherited from AbstractInputProcessor.constructor

Properties

`Static` MODELGEN_INFFERED_NAME

MODELGEN_INFFERED_NAME: string = 'x-modelgen-inferred-name'

`Static` supportedVersions

supportedVersions: string[] = ...

Methods

`Private` includeParameters

includeParameters(parameters, path, inputModel, options?): void
Parameters
- parameters: undefined | Parameters
- path: string
- inputModel: InputMetaModel
- Optional options: ProcessorOptions
Returns void
- Defined in src/processors/SwaggerInputProcessor.ts:119

`Private` includeResponses

includeResponses(responses, path, inputModel, options?): void
Parameters
- responses: ResponsesObject
- path: string
- inputModel: InputMetaModel
- Optional options: ProcessorOptions
Returns void
- Defined in src/processors/SwaggerInputProcessor.ts:96

`Private` includeSchema

includeSchema(schema, name, inputModel, options?): void
Parameters
- schema: SchemaObject
- name: string
- inputModel: InputMetaModel
- Optional options: ProcessorOptions
Returns void
- Defined in src/processors/SwaggerInputProcessor.ts:139

process

process(input, options?): Promise<InputMetaModel>
Process the input as a Swagger document
Parameters
- input: any
- Optional options: ProcessorOptions
Returns Promise<InputMetaModel>
Overrides AbstractInputProcessor.process
- Defined in src/processors/SwaggerInputProcessor.ts:19

`Private` processOperation

processOperation(operation, path, inputModel, options?): void
Parameters
- operation: undefined | {
      consumes?: MimeTypes;
      deprecated?: boolean;
      description?: string;
      externalDocs?: ExternalDocumentationObject;
      operationId?: string;
      parameters?: Parameters;
      produces?: MimeTypes;
      responses: ResponsesObject;
      schemes?: string[];
      security?: SecurityRequirementObject[];
      summary?: string;
      tags?: string[];
  }
- path: string
- inputModel: InputMetaModel
- Optional options: ProcessorOptions
Returns void
- Defined in src/processors/SwaggerInputProcessor.ts:84

shouldProcess

shouldProcess(input): boolean
Figures out if an object is of type Swagger document and supported
Parameters
- input: any
Returns boolean
Overrides AbstractInputProcessor.shouldProcess
- Defined in src/processors/SwaggerInputProcessor.ts:187

tryGetVersionOfDocument

tryGetVersionOfDocument(input): undefined | string
Try to find the swagger version from the input. If it cannot, undefined are returned, if it can, the version is returned.
Parameters
- input: any
Returns undefined | string
- Defined in src/processors/SwaggerInputProcessor.ts:200

`Static` convertToInternalSchema

convertToInternalSchema(schema, name): SwaggerV2Schema
Converts a Swagger 2.0 Schema to the internal schema format.
Parameters
- schema: SchemaObject
  to convert
- name: string
  of the schema
Returns SwaggerV2Schema
- Defined in src/processors/SwaggerInputProcessor.ts:168

Class SwaggerInputProcessor

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SwaggerInputProcessor

Properties

Static MODELGEN_INFFERED_NAME

Static supportedVersions

Methods

Private includeParameters

Parameters

Returns void

Private includeResponses

Parameters

Returns void

Private includeSchema

Parameters

Returns void

process

Parameters

Returns Promise<InputMetaModel>

Private processOperation

Parameters

Returns void

shouldProcess

Parameters

Returns boolean

tryGetVersionOfDocument

Parameters

Returns undefined | string

Static convertToInternalSchema

Parameters

Returns SwaggerV2Schema

Settings

Member Visibility

Theme

On This Page

`Static` MODELGEN_INFFERED_NAME

`Static` supportedVersions

`Private` includeParameters

`Private` includeResponses

`Private` includeSchema

`Private` processOperation

`Static` convertToInternalSchema