Class OpenApiUrlProvider

An entity generation provider using an open api url.

Implements

EntityGenerationProvider

Index

Constructors

Properties

generateSchemasFromPaths markAsEntities prefix

Methods

Constructors

constructor

new OpenApiUrlProvider(
    prefix: string,
    baseUrl: string,
    generateSchemasFromPaths?: boolean,
    markAsEntities?: boolean,
): OpenApiUrlProvider
Parameters
- prefix: string
- baseUrl: string
- generateSchemasFromPaths: boolean = false
- markAsEntities: boolean = false
Returns OpenApiUrlProvider
- Defined in src/entity/generation/providers/open-api-url.provider.ts:19

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-url.provider.ts:27