Class RestApi

Hierarchy

Component
- RestApi

Index

Constructors

Properties

options project

Methods

addRestResource createConstructFile createEntryFile postSynthesize preSynthesize synthesize

Constructors

constructor

new RestApi(app: AwsCdkTypeScriptApp, options: RestApiOptions): RestApi
Parameters
- app: AwsCdkTypeScriptApp
- options: RestApiOptions
Returns RestApi

Overrides pj.Component.constructor

Properties

`Protected` options

options: RestApiOptions

`Readonly` project

project: Project

Methods

`Protected` addRestResource

addRestResource(apiSpec: OpenAPI3, path: string, method: string): void
Parameters
- apiSpec: OpenAPI3
- path: string
- method: string
Returns void

`Protected` createConstructFile

createConstructFile(fileName: string): void
Parameters
- fileName: string
Returns void

`Protected` createEntryFile

createEntryFile(entryFile: string, method: string, operationId: string): void
Parameters
- entryFile: string
- method: string
- operationId: string
Returns void

postSynthesize

postSynthesize(): void
Called after synthesis. Order is not guaranteed.

Returns void

Inherited from pj.Component.postSynthesize

preSynthesize

preSynthesize(): void
Called before synthesis.

Returns void

Inherited from pj.Component.preSynthesize

synthesize

synthesize(): void
Synthesizes files to the project output directory.

Returns void

Inherited from pj.Component.synthesize

Generated using TypeDoc