Skip to main content

Convenient wrapper around CfnApi.

Project description

B.CfnApiV2

Pipeline

An API Gateway resource that adds convenient functionality over traditional CfnApi resource. It lets you easily enable authorization, stages, and CDNs.

Description

Essentially this resource is a wrapper resource for aws_apigatewayv2 module's CfnApi. Meaning, that you can easily swap CfnApi and this Api resource with no major impact. But why would you want to switch a traditional CfnApi to this one. Mainly these convenient features:

  • Easy to add CloudFront distribution on top of the API (enabling CDN).
  • Easy to enable Stage and attached to the api.
  • Easy to add authorization with UserPoolAuthorizer & ApiKeyAuthorizer.

Remarks

Biomapas aims to modernise life-science industry by sharing its IT knowledge with other companies and the community. This is an open source library intended to be used by anyone. Improvements and pull requests are welcome.

Related technology

  • Python3
  • AWS CDK
  • AWS Lambda
  • AWS API Gateway
  • AWS CloudFront
  • AWS User Pool authorization

Assumptions

This project assumes you know what Lambda functions are and how code is being shared between them (Lambda layers).

  • Excellent knowledge in IaaC (Infrastructure as a Code) principles.
  • Excellent knowledge in Lambda functions and API Gateway service.
  • Good experience in AWS CDK and AWS CloudFormation.

Useful sources

Install

Before installing this library, ensure you have these tools setup:

  • Python / Pip
  • AWS CDK

To install this project from source run:

pip install .

Or you can install it from a PyPi repository:

pip install b-cfn-api-v2

Usage & Examples

The traditional way of creating an API looks something like this:

from aws_cdk.aws_apigatewayv2 import CfnApi

CfnApi(
    scope=Stack(),
    id='Api',
    name='Api',
    description='Sample description.',
    protocol_type='HTTP',
    cors_configuration=CfnApi.CorsProperty(
        allow_methods=['GET', 'PUT', 'POST', 'OPTIONS', 'DELETE'],
        allow_origins=['*'],
        allow_headers=[
            'Content-Type',
            'Authorization'
        ],
        max_age=300
    )
)

To create our resource Api is exactly the same:
(It works since Api is a pure wrapper of CfnApi resource.)

from b_cfn_api_v2.api import Api

Api(
    scope=Stack(),
    id='Api',
    name='Api',
    description='Sample description.',
    protocol_type='HTTP',
    cors_configuration=Api.CorsProperty(
        allow_methods=['GET', 'PUT', 'POST', 'OPTIONS', 'DELETE'],
        allow_origins=['*'],
        allow_headers=[
            'Content-Type',
            'Authorization'
        ],
        max_age=300
    )
)

Three main advantages of this Api resource:

  • Easy to enable default stage.
from b_cfn_api_v2.api import Api

api = Api(...)
api.enable_default_stage('dev')
  • Easy to enable authorization.
from b_cfn_api_v2.api import Api
from b_cfn_custom_userpool_authorizer.config.user_pool_config import UserPoolConfig

api = Api(...)

# Your authorized endpoint will require `Authorization`
# supplied in headers.
# Read more:
# https://github.com/Biomapas/B.CfnCustomUserPoolAuthorizer
api.enable_user_pool_authorizer(UserPoolConfig(
    user_pool_id='id',
    user_pool_region='region',
    user_pool_client_id='client'
))

# Your authorized endpoint will require `ApiKey` and `ApiSecret`
# supplied in headers.
# Read more:
# https://github.com/Biomapas/B.CfnCustomApiKeyAuthorizer
api.enable_api_key_authorizer()
  • Easy to enable CDN.
from b_cfn_api_v2.api import Api
from aws_cdk.aws_cloudfront import CachePolicy

api = Api(...)
api.enable_cdn(default_behavior_cache_policy=CachePolicy.CACHING_OPTIMIZED)

Testing

This package has integration tests based on pytest. To run tests simply run:

pytest b_cfn_api_v2_test/integration/tests

Contribution

Found a bug? Want to add or suggest a new feature? Contributions of any kind are gladly welcome. You may contact us directly, create a pull-request or an issue in github platform. Lets modernize the world together.

Release history

5.0.0

  • Upgrade CDK support from v1 to v2.
  • Upgrade GitHub pipelines checkout version from v2 to v3.
  • Set GitHub pipelines node version 18.
  • Set GitHub pipelines python version 3.10.

4.0.0

  • Fix origin paths between pure api or its cloudfront distribution. Both should require stage name to be entered as a part of a URL. This is a breaking change.

3.1.0

  • Enable easy stage logging.

3.0.0

  • Upgrade breaking dependencies.

2.0.1

  • Make dependencies range more loose with maximum version not reaching 2.0.0.

2.0.0

  • Use the newest 2.0.0 custom api keys authorizer which now hashes api secrets and is no longer compatible with previous versions.

1.1.1

  • Update readme.

1.1.0

1.0.0

  • Fully documented, tested, and working version release.

0.0.1

  • Initial build.

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

b_cfn_api_v2-5.0.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

b_cfn_api_v2-5.0.0-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file b_cfn_api_v2-5.0.0.tar.gz.

File metadata

  • Download URL: b_cfn_api_v2-5.0.0.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for b_cfn_api_v2-5.0.0.tar.gz
Algorithm Hash digest
SHA256 5d73deae8a6811ff3e46f5434594c88a6eb5523b4a27d1cdce08be50efad7400
MD5 1abf70ffdf2e7461f6223edfff94a6f9
BLAKE2b-256 dad42509d507f29a1d8db372e97123a4184f3b480691789f486465232d5e8513

See more details on using hashes here.

File details

Details for the file b_cfn_api_v2-5.0.0-py3-none-any.whl.

File metadata

  • Download URL: b_cfn_api_v2-5.0.0-py3-none-any.whl
  • Upload date:
  • Size: 22.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for b_cfn_api_v2-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b6ebe277ec5f03d4ced65ef0823de30e693bfa9791a74682f4f14d90862a34dc
MD5 84584037c3843b7225435968426b39bf
BLAKE2b-256 d305bbb6fda2b538836372e130d2f3cc0e8f5aadc18d39c0e505d22d0077d185

See more details on using hashes here.

Supported by

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