Class RestApi<PATHS, OPS>

Type Parameters

PATHS
OPS

Hierarchy

BaseApi
- RestApi

Index

Constructors

Properties

_functions api apiSpec node props

Methods

addCustomRestResource addRestResource cleanupSpec getFunctionForOperation getFunctions patchSecurity tableWriteAccessForMethod toString isConstruct

Constructors

constructor

new RestApi<PATHS, OPS>(scope: Construct, id: string, props: RestApiProps<OPS>): RestApi<PATHS, OPS>
Type Parameters
- PATHS
- OPS
Parameters
- scope: Construct
- id: string
- props: RestApiProps<OPS>
Returns RestApi<PATHS, OPS>

Overrides BaseApi.constructor

Properties

`Private` _functions

_functions: {
[operationId: string]: LambdaFunction;
} = {}

Type declaration

[operationId: string]: LambdaFunction

`Readonly` api

api: SpecRestApi

`Readonly` apiSpec

apiSpec: OpenAPI3

`Readonly` node

node: Node

The tree node.

Stability

stable

`Private` props

props: RestApiProps<OPS>

Methods

addCustomRestResource

addCustomRestResource(operation: OperationObject, method: string, description: string, additionalLambdaOptions?: LambdaOptions): undefined | LambdaFunction
Parameters
- operation: OperationObject
- method: string
- description: string
- additionalLambdaOptions: LambdaOptions = {}
Returns undefined | LambdaFunction

addRestResource

addRestResource<P>(path: P, method: keyof PATHS[P]): undefined | LambdaFunction
Type Parameters
- P extends string | number | symbol
Parameters
- path: P
- method: keyof PATHS[P]
Returns undefined | LambdaFunction

`Protected` cleanupSpec

cleanupSpec(spec: {
[key: string]: any;
}): {
[key: string]: any;
}
Parameters
- spec: {
  [key: string]: any;
  }
  - [key: string]: any
Returns {
[key: string]: any;
}
- [key: string]: any

getFunctionForOperation

getFunctionForOperation(operationId: keyof OPS): LambdaFunction
return the generated Lambda function for the specified API operation
Parameters
- operationId: keyof OPS
Returns LambdaFunction

getFunctions

getFunctions(): LambdaFunction[]
return a list of all generated Lambda functions

Returns LambdaFunction[]

`Protected` patchSecurity

patchSecurity(spec: OpenAPI3): void
AWS does not properly apply the 'security' option to every single path-method. According to documentation, global security gets applied, if there is no security set for the particular path-method. If there is any, even empty, it will get precedence. THIS DOES NOT HAPPEN ON AWS. IT JUST ALWAYS USES THE GLOBAL SETTING!

'security applies [...] schemes globally to all API operations, unless overridden on the operation level'

See
https://swagger.io/docs/specification/authentication/
Parameters
- spec: OpenAPI3
Returns void

`Private` tableWriteAccessForMethod

tableWriteAccessForMethod(method: string): boolean
Parameters
- method: string
Returns boolean

toString

toString(): string
Returns a string representation of this construct.

Stability
stable

Returns string

Inherited from BaseApi.toString

`Static` isConstruct

isConstruct(x: any): x is Construct
(deprecated) Checks if x is a construct.

Returns
true if x is an object created from a class which extends Construct.

Deprecated
use x instanceof Construct instead
Parameters
- x: any
  
  Any object.
Returns x is Construct

Inherited from BaseApi.isConstruct

Generated using TypeDoc