Skip to main content

cdk-alps-spec-rest-api

Project description

NPM version PyPI version Maven Central .NET version Release

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

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


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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cdk_alps_spec_rest_api-0.1.10-py3-none-any.whl (217.4 kB view details)

Uploaded Python 3

File details

Details for the file cdk-alps-spec-rest-api-0.1.10.tar.gz.

File metadata

  • Download URL: cdk-alps-spec-rest-api-0.1.10.tar.gz
  • Upload date:
  • Size: 218.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9

File hashes

Hashes for cdk-alps-spec-rest-api-0.1.10.tar.gz
Algorithm Hash digest
SHA256 84db3d25f0cc470d47fbd89b80e953f6d64c9a20fe897ddc94f08e52922f33fb
MD5 acd8e20d316a60ce067042a4cefd20c0
BLAKE2b-256 460f9f675b7b42bd849d946562b2b969d221d61d383022d5e7fa5a2358a68bfb

See more details on using hashes here.

File details

Details for the file cdk_alps_spec_rest_api-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: cdk_alps_spec_rest_api-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 217.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9

File hashes

Hashes for cdk_alps_spec_rest_api-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 af5d694fec57b77443300e3d6ab1bfe784ad9d2f308362f21fde4d8e0a3f966a
MD5 acb89513fd30d6fd4d5710a65b8ea188
BLAKE2b-256 24205e1a3b42af920e9090f766a029a2fe53868425e04ec3b1f738cc51a163ec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page