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

indieisaconcept · 2024-08-29T11:21:55Z

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`),
      }
    }
  ]
});

… an inline api definition 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.

aws-solutions-constructs-team · 2024-08-29T11:30:45Z

AWS CodeBuild CI Report

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

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

biffgaut · 2024-08-29T11:35:01Z

Thanks - we'll take a look!

aws-solutions-constructs-team · 2024-09-03T00:49:44Z

AWS CodeBuild CI Report

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

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

biffgaut · 2024-09-03T20:02:58Z

source/patterns/@aws-solutions-constructs/aws-openapigateway-lambda/lib/index.ts

+    if (!apiDefinitionInline) {
+      // This custom resource will overwrite the string placeholders in the openapi definition with the resolved values of the lambda URIs
+      apiDefinitionWriter = resources.createTemplateWriterCustomResource(this, 'Api', {
+        // CheckAlbProps() has confirmed the existence of these values


CheckOpenapiProps(), not alb

Good catch - I've amended.

aws-solutions-constructs-team · 2024-09-04T03:30:22Z

AWS CodeBuild CI Report

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

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

aws-solutions-constructs-team · 2024-09-06T02:22:44Z

AWS CodeBuild CI Report

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

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

aws-solutions-constructs-team · 2024-09-09T21:34:49Z

AWS CodeBuild CI Report

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

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

indieisaconcept · 2024-09-09T23:46:13Z

source/patterns/@aws-solutions-constructs/aws-openapigateway-lambda/lib/openapi-helper.ts

+      apiDefinitionWriter.s3Key
+    );
+  } else if (apiRawInlineSpec) {
+    const apiInlineSpec = new apigateway.InlineApiDefinition(apiRawInlineSpec);


Perhaps this isn't needed since apiRawInlineSpec is technically already expected to be a JSON object. Unless you are relying on the initial assignment to trigger validation, which would make sense in this instance. Non-and empty objects would throw.

Yep, code is redundant to the check already done in CheckOpenapiProps. But including it makes the code explicit, these steps aren't just executing because it is "not something else", it is executing because it IS "this". Putting that in code is better than a comment - even at the cost of a couple clock ticks.

aws-solutions-constructs-team · 2024-09-10T18:34:53Z

AWS CodeBuild CI Report

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

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

aws-solutions-constructs-team · 2024-09-10T18:56:50Z

AWS CodeBuild CI Report

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

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

aws-solutions-constructs-team · 2024-09-10T19:45:35Z

AWS CodeBuild CI Report

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

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

georgebearden · 2024-09-10T19:38:49Z

source/patterns/@aws-solutions-constructs/aws-openapigateway-lambda/README.md

@@ -126,6 +126,7 @@ new OpenApiGatewayToLambda(this, "OpenApiGatewayToLambda", OpenApiGatewayToLambd
 |apiDefinitionBucket?|[`s3.IBucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html)|S3 Bucket where the OpenAPI spec file is located. When specifying this property, `apiDefinitionKey` must also be specified.|
 |apiDefinitionKey?|`string`|S3 Object name of the OpenAPI spec file. When specifying this property, `apiDefinitionBucket` must also be specified.|
 |apiDefinitionAsset?|[`aws_s3_assets.Asset`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3_assets.Asset.html)|Local file asset of the OpenAPI spec file.|
+|apiJsonDefinition?|any|OpenAPI specification represented in a JSON object to be included in the CloudFormation template. IMPORTANT - Including the spec in the template introduces a risk of the template growing too big, but there are some use cases that require an embedded spec. Unless your use case explicitly requires an embedded spec you should pass your spec as an S3 asset.|


This is just a nit, that the naming convention for the other api definition properties followed apiDefinition{thing}.

georgebearden · 2024-09-10T19:40:38Z

source/patterns/@aws-solutions-constructs/aws-openapigateway-lambda/lib/index.ts

+import { ApiIntegration, CheckOpenapiProps, TokenToFunctionMapping, ObtainApiDefinition } from './openapi-helper';
+export { ApiIntegration, TokenToFunctionMapping as ApiLambdaFunction } from './openapi-helper';


As we don't normally export imports? in this library, could we add a comment here explaining the why and how its used?

georgebearden · 2024-09-10T19:41:50Z

source/patterns/@aws-solutions-constructs/aws-openapigateway-lambda/lib/index.ts

@@ -77,6 +36,13 @@ export interface OpenApiGatewayToLambdaProps {
   * Local file asset of the OpenAPI spec file.
   */
  readonly apiDefinitionAsset?: Asset;
+  /**
+   * The OpenApi spec represented as a json object to be included in the CloudFormation template.


The AS A JSON OBJECT bit of this is important, as a yaml-defined openapi spec wouldn't work, though is probably the more common format to define it. How can we better call that out in this comment to make sure customers know?

To me the key point is that this definition will be embedded in the template, so the comment is focused on that. The README is slightly different, do you like that any better?

Not passing JSON would cause this to die at synth time, right? I think its fine.

georgebearden · 2024-09-10T19:43:28Z

source/patterns/@aws-solutions-constructs/aws-openapigateway-lambda/lib/openapi-helper.ts

+/**
+ * @internal This is an internal core function and should not be called directly by Solutions Constructs clients.
+ */
+export function CheckOpenapiProps(props: OpenApiProps) {


Nit - CheckOpenApiProps to match the casing of OpenApi elsewhere in this code.

aws-solutions-constructs-team · 2024-09-10T19:56:10Z

AWS CodeBuild CI Report

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

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

aws-solutions-constructs-team · 2024-09-10T19:56:17Z

AWS CodeBuild CI Report

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

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

aws-solutions-constructs-team · 2024-09-10T19:58:30Z

AWS CodeBuild CI Report

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

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

georgebearden

looks good to me

aws-solutions-constructs-team · 2024-09-10T20:00:56Z

AWS CodeBuild CI Report

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

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

aws-solutions-constructs-team · 2024-09-10T20:14:05Z

AWS CodeBuild CI Report

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

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

aws-solutions-constructs-team · 2024-09-10T21:05:18Z

AWS CodeBuild CI Report

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

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

indieisaconcept requested review from biffgaut, hayesry, mobri2a, emcfins and georgebearden as code owners August 29, 2024 11:21

Merge branch 'main' into feat/apigateway-inline-asset

f5b8a32

biffgaut reviewed Sep 3, 2024

View reviewed changes

fix: amend typo in comment

2de0bfa

Merge branch 'main' into feat/apigateway-inline-asset

b4a1065

Constructs Team Updates

8d3afeb

indieisaconcept commented Sep 9, 2024

View reviewed changes

Final edits (new tests, var name changes)

f57f5e0

Merge branch 'main' into feat/apigateway-inline-asset

abe6882

Sync README

8267121

georgebearden reviewed Sep 10, 2024

View reviewed changes

biffgaut added 4 commits September 10, 2024 15:47

Change name back

0ec5439

Comment on the export

15f7f20

Change name to apiDefinitionJson

a45c703

Address comments

b0d27f1

georgebearden previously approved these changes Sep 10, 2024

View reviewed changes

trailing whitespace

584a215

biffgaut dismissed georgebearden’s stale review via 584a215 September 10, 2024 20:07

aws-solutions-constructs-team previously approved these changes Sep 10, 2024

View reviewed changes

Build tweaks

52fbcad

biffgaut dismissed aws-solutions-constructs-team’s stale review via 52fbcad September 10, 2024 20:56

aws-solutions-constructs-team approved these changes Sep 10, 2024

View reviewed changes

georgebearden approved these changes Sep 10, 2024

View reviewed changes

aws-solutions-constructs-team merged commit b1baf59 into awslabs:main Sep 11, 2024
2 checks passed

indieisaconcept deleted the feat/apigateway-inline-asset branch September 12, 2024 02:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

indieisaconcept commented Aug 29, 2024

aws-solutions-constructs-team commented Aug 29, 2024

biffgaut commented Aug 29, 2024

aws-solutions-constructs-team commented Sep 3, 2024

biffgaut Sep 3, 2024

indieisaconcept Sep 4, 2024

aws-solutions-constructs-team commented Sep 4, 2024

aws-solutions-constructs-team commented Sep 6, 2024

aws-solutions-constructs-team commented Sep 9, 2024

indieisaconcept Sep 9, 2024

aws-solutions-constructs-team Sep 10, 2024

aws-solutions-constructs-team commented Sep 10, 2024

aws-solutions-constructs-team commented Sep 10, 2024

aws-solutions-constructs-team commented Sep 10, 2024

georgebearden Sep 10, 2024

georgebearden Sep 10, 2024

georgebearden Sep 10, 2024

aws-solutions-constructs-team Sep 10, 2024

georgebearden Sep 10, 2024

georgebearden Sep 10, 2024

aws-solutions-constructs-team commented Sep 10, 2024

aws-solutions-constructs-team commented Sep 10, 2024

aws-solutions-constructs-team commented Sep 10, 2024

georgebearden left a comment

aws-solutions-constructs-team commented Sep 10, 2024

aws-solutions-constructs-team commented Sep 10, 2024

aws-solutions-constructs-team commented Sep 10, 2024

		import { ApiIntegration, CheckOpenapiProps, TokenToFunctionMapping, ObtainApiDefinition } from './openapi-helper';
		export { ApiIntegration, TokenToFunctionMapping as ApiLambdaFunction } from './openapi-helper';

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

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

Conversation

indieisaconcept commented Aug 29, 2024

aws-solutions-constructs-team commented Aug 29, 2024

AWS CodeBuild CI Report

biffgaut commented Aug 29, 2024

aws-solutions-constructs-team commented Sep 3, 2024

AWS CodeBuild CI Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-solutions-constructs-team commented Sep 4, 2024

AWS CodeBuild CI Report

aws-solutions-constructs-team commented Sep 6, 2024

AWS CodeBuild CI Report

aws-solutions-constructs-team commented Sep 9, 2024

AWS CodeBuild CI Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-solutions-constructs-team commented Sep 10, 2024

AWS CodeBuild CI Report

aws-solutions-constructs-team commented Sep 10, 2024

AWS CodeBuild CI Report

aws-solutions-constructs-team commented Sep 10, 2024

AWS CodeBuild CI Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-solutions-constructs-team commented Sep 10, 2024

AWS CodeBuild CI Report

aws-solutions-constructs-team commented Sep 10, 2024

AWS CodeBuild CI Report

aws-solutions-constructs-team commented Sep 10, 2024

AWS CodeBuild CI Report

georgebearden left a comment

Choose a reason for hiding this comment

aws-solutions-constructs-team commented Sep 10, 2024

AWS CodeBuild CI Report

aws-solutions-constructs-team commented Sep 10, 2024

AWS CodeBuild CI Report

aws-solutions-constructs-team commented Sep 10, 2024

AWS CodeBuild CI Report