cdk-rest-api-with-spec.md

Home > @codemonger-io/cdk-rest-api-with-spec

cdk-rest-api-with-spec package

Describe the Amazon API Gateway and OpenAPI definition at once with CDK.

Classes

Class	Description
ParameterKey	(BETA) Parsed request or response parameter key.
RestApiWithSpec	(BETA) CDK construct that provisions an API Gateway REST API endpoint and also synthesizes the OpenAPI definition for it.

Functions

Function	Description
augmentAuthorizer(authorizer, securitySchemeObject)	(BETA) Makes a given aws_apigateway.IAuthorizer an IAuthorizerWithSpec by augmenting it with a specified security scheme object.

Interfaces

Interface	Description
IAuthorizerWithSpec	(BETA) Authorizer augmented with the features to describe the OpenAPI definition.
IResourceWithSpec	(BETA) aws_apigateway.IResource augmented with the features to build the OpenAPI definition.
IRestApiWithSpec	(BETA) aws_apigateway.RestApi augmented with the features to build the OpenAPI definition.
JsonSchemaEx	(BETA) Extended aws_apigateway.JsonSchema.
MethodOptionsWithSpec	(BETA) aws_apigateway.MethodOptions augmented with the properties necessary to build the OpenAPI definition.
MethodResponseWithSpec	(BETA) aws_apigateway.MethodResponse augmented with properties necessary for the OpenAPI definition.
ModelOptionsWithSpec	(BETA) aws_apigateway.ModelOptions augmented with the properties necessary to build the OpenAPI definition.
ResourceOptionsWithSpec	(BETA) aws_apigateway.ResourceOptions augmented with the properties necessary to build the OpenAPI definition.
RestApiWithSpecProps	(BETA) Properties for RestApiWithSpec.