Class OpenApiFileProvider

An entity generation provider using a local open api file.

Implements

EntityGenerationProvider

Index

Constructors

Properties

generateSchemasFromPaths markAsEntities prefix

Methods

Constructors

constructor

new OpenApiFileProvider(
    prefix: string,
    filePath: Path,
    generateSchemasFromPaths?: boolean,
    markAsEntities?: boolean,
): OpenApiFileProvider
Parameters
- prefix: string
- filePath: Path
- generateSchemasFromPaths: boolean = false
- markAsEntities: boolean = false
Returns OpenApiFileProvider
- Defined in src/entity/generation/providers/open-api-file.provider.ts:10

Properties

`Readonly`generateSchemasFromPaths

generateSchemasFromPaths: boolean = false

Whether or not to generate schemas from openapi paths.

`Readonly`markAsEntities

markAsEntities: boolean = false

Whether or not the generated entities should be marked with @Entity.

`Readonly`prefix

prefix: string

The prefix to add to all generated entities, so that they don't overlap with any existing ones.

Methods

resolveSpec

resolveSpec(): Promise<OpenAPIObject>
The method that actually resolves the open api spec that is then later on used to generate the entities.

Returns Promise<OpenAPIObject>
Implementation of EntityGenerationProvider.resolveSpec
- Defined in src/entity/generation/providers/open-api-file.provider.ts:18