Skip to content

Commit

Permalink
feat: Readme thanks and explanations
Browse files Browse the repository at this point in the history
  • Loading branch information
martin.mueller committed Nov 25, 2020
1 parent 317dcb3 commit 4143e9c
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,20 @@

# CDK Alps Spec Rest Api

CDK Construct library constructed with the help of Pahud https://www.youtube.com/watch?v=cTsSXYOYQPw&t=2s <3.
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.

# ALPS
The AWS CDK construct repo was generated with [Projen](https://github.com/projen/projen) as **awscdk-construct**

https://github.com/mamund/alps-unified
# 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&t

# Sample

Expand All @@ -17,11 +26,17 @@ const app = new cdk.App();

const stack = new cdk.Stack(app, 'my-demo-stack', { env });

new AlpsSpecRestApi(stack, 'AlpsSpecRestApi');
new AlpsSpecRestApi(stack, 'AlpsSpecRestApi', {
specFile: 'src/todo-oas.yaml',
});
```

# Deploy the CDK stack

```ts
npx cdk --app lib/integ.default.js --profile damadden88 deploy
```

# Limitations / Issues / TODOS

- (AWS) Authorizer and Validator are not supported yet

0 comments on commit 4143e9c

Please sign in to comment.