cdk-alps-spec-rest-api
Project 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
app = cdk.App()
stack = cdk.Stack(app, "my-demo-stack", env=env)
AlpsSpecRestApi(stack, "AlpsSpecRestApi",
alps_spec_file="src/todo-alps.yaml"
)
CDK stack commands
Diff
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
npxcdk --applib / integ.default.js --profile < profile > diff
Deploy
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
npxcdk --applib / integ.default.js --profile < profile > deploy
Destroy
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
npxcdk --applib / 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cdk-alps-spec-rest-api-0.1.10.tar.gz
(218.3 kB
view hashes)
Built Distribution
Close
Hashes for cdk-alps-spec-rest-api-0.1.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84db3d25f0cc470d47fbd89b80e953f6d64c9a20fe897ddc94f08e52922f33fb |
|
MD5 | acd8e20d316a60ce067042a4cefd20c0 |
|
BLAKE2b-256 | 460f9f675b7b42bd849d946562b2b969d221d61d383022d5e7fa5a2358a68bfb |
Close
Hashes for cdk_alps_spec_rest_api-0.1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | af5d694fec57b77443300e3d6ab1bfe784ad9d2f308362f21fde4d8e0a3f966a |
|
MD5 | acb89513fd30d6fd4d5710a65b8ea188 |
|
BLAKE2b-256 | 24205e1a3b42af920e9090f766a029a2fe53868425e04ec3b1f738cc51a163ec |