feat(aws-openapigateway-lambda): update construct to allow specifying an inline api definition - Githubissues

awslabs / aws-solutions-constructs

The AWS Solutions Constructs Library is an open-source extension of the AWS Cloud Development Kit (AWS CDK) that provides multi-service, well-architected patterns for quickly defining solutions

https://docs.aws.amazon.com/solutions/latest/constructs/

Apache License 2.0

1.25k stars 249 forks source link

feat(aws-openapigateway-lambda): update construct to allow specifying an inline api definition #1190

Closed indieisaconcept closed 2 months ago

indieisaconcept commented 3 months ago

Issue #, if available:

Description of changes:

The rationale for this change is to improve the local developer experience and enable compatibility with sam local start-api. Previously, the construct only supported referencing an external OpenAPI definition file, which made it challenging to work with an API locally during development.

Example Usage

const isLocal = this.node.tryGetContext('api-local') as string | undefined;

const apiDefinition = isLocal ? {
  apiDefinitionInline: new InlineApiDefinition(definition)
} : {
  apiDefinitionAsset: new Asset(this, 'ApiDefinitionAsset', {
    path: path.join(__dirname, 'openapi/apiDefinition.yaml'),
  }),
};

new OpenApiGatewayToLambda(this, 'OpenApiGatewayToLambda', {
  ...apiDefinition,
  apiIntegrations: [
    {
      id: 'MessagesHandler',
      lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_18_X,
        handler: 'index.handler',
        code: lambda.Code.fromAsset(`${__dirname}/messages-lambda`),
      }
    }
  ]
});

aws-solutions-constructs-team commented 3 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 966f511510fe09d41e547c079611369badb428c0
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

biffgaut commented 3 months ago

Thanks - we'll take a look!

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: f5b8a3281e223c0186fa47e543b42be03c17e5e9
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 2de0bfaf3d3fd8ce75bf688dd8f08a257d234218
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: b4a1065ba31236fe8cd733172ab546600f172f1e
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 8d3afeb9cf151717119eaa9b27c3dca364e1fcf5
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: f57f5e07d9136e3b602734263c24e25e718ef4e8
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: abe6882d8a099d390f8bd2093adb16f4a12c68bc
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 8267121aa177a05649ada7a16ef09bc13d0dff80
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: a45c703e735deff3ae96cf49b52b0fa241fa36f7
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 0ec54390af70513de8494a8c01e43d22f3745ecc
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 15f7f206740366e2bb53eefd743010c26c27053a
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: b0d27f18215cae7ac45b01779739d61a235478f8
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 584a215caf03e97b5f7b309ca4141220d0b1f7d4
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 52fbcad9fd13a884d46f53832c4dbb3457bd0b44
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository