@Stability(value=Stable)

Package com.github.mmuller88.cdkAlpsSpecRestApi

See: Description

Interface Summary

Interface	Description
AlpsSpecRestApiProps

Class Summary

Class	Description
AlpsSpecRestApi
AlpsSpecRestApi.Builder	A fluent builder for AlpsSpecRestApi.
AlpsSpecRestApiProps.Builder	A builder for AlpsSpecRestApiProps
AlpsSpecRestApiProps.Jsii$Proxy	An implementation for AlpsSpecRestApiProps

Package com.github.mmuller88.cdkAlpsSpecRestApi Description

CDK Alps Spec Rest Api

The CDK Alps Spec Rest Api construct generates an AWS API Gateway out of an ALPS API yaml file such src/todo-alps.yaml. ALPS API is an abstraction of APIs like REST API or Graph QL. More about the ALPS API see in the ALPS API section.

The AWS CDK construct repo was generated with Projen as awscdk-construct

Thanks

• To Pahud for the helpful AWS CDK Construct video: https://www.youtube.com/watch?v=cTsSXYOYQPw
• Mike Amundsen for the ALPS API idea and help

ALPS API

The ALPS API converter is on GitHub on: https://github.com/mamund/alps-unified

Very useful to understand the idea of ALPS API is this video on YouTube: https://www.youtube.com/watch?v=oG6-r3UdenE

Sample

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 Object app = new App();
 
 Object stack = Stack.Builder.create(app, "my-demo-stack").env(env).build();
 
 AlpsSpecRestApi.Builder.create(stack, "AlpsSpecRestApi")
         .alpsSpecFile("src/todo-alps.yaml")
         .build();
 

CDK stack commands

Diff

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 npx;cdk --;app;lib / integ.default.js --;profile < profile > diff;
 

Deploy

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 npx;cdk --;app;lib / integ.default.js --;profile < profile > deploy;
 

Destroy

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 npx;cdk --;app;lib / integ.default.js --;profile < profile > destroy;
 

Limitations / Issues / TODOS

• (AWS) Authorizer and Validator are not supported yet
• only alps YAML files are supported. alps JSON files will be added
• only Lambda integrations are supported and the endpoints are per default mapped to lambdas with the same name as the operationId.