Skip to main content

cdk-alps-spec-rest-api

Project description

NPM version PyPI version Maven version .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.8.tar.gz (218.1 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.8-py3-none-any.whl (217.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cdk-alps-spec-rest-api-0.1.8.tar.gz
  • Upload date:
  • Size: 218.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.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.8.tar.gz
Algorithm Hash digest
SHA256 4c5b95953be3e997705c96222231744b0fcff06458635737fa859f409bc28246
MD5 bf52f981fb9081c87a3a8825fc325907
BLAKE2b-256 f66c1abc0ce4627edd7c8e50299857f52c98f51de623c4c89164461d5586c5a5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cdk_alps_spec_rest_api-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 217.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 5d7638dff23974c1477da071f8b92536d32a2a99e7b229baa5806179dfacebb4
MD5 4c01b0c8402d83eff4254f9e3d038189
BLAKE2b-256 9224375d21179c4b1fcb7b3ab7a10d38bfd1a75d11df7ab27a171c020442e8b4

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