Lambda Annotations API Routing

Open
#1,616 2 comments 6 reactions 1 assignee View on GitHub

@normj is already working on this.

Since Nov 17, 2023.

Assessment

This issue has not been assessed yet.

Description

annotations feature-request p2
Describe the feature

With the release of the [LambdaGlobalProperties] attribute that can auto-generate the static Main() method for non managed and native AOT runtimes this functionality could be extended to provide API routing capabilities. The API annotations on methods could be used as part of a switch statement for the inbound API event.

Use Case

Running a simple web API on Lambda without needing to introduce the overhead of ASP.NET. Removes the need to set the ANNOTATIONS_HANDLER environment variable when running multiple API endpoints in the same Lambda function.

Allows the use of an API Gateway {proxy+} route with all API request routing to the same Lambda function.

Proposed Solution

The GenerateMain global properties attribute adds a switch statement based on an environment variable. Introduce a new ApiRouting Lambda Global Property that will generate the static Main method. Include a switch statement that uses a combination of the HttpMethod and Path from the incoming API event to route to the correct method.

Example of generated code:

public static async Task Main(string[] args)
{
    Func<APIGatewayProxyRequest , Task<APIGatewayProxyResponse>> apiHandler = Handler;
    await Amazon.Lambda.RuntimeSupport.LambdaBootstrapBuilder.Create(apiHandler, new Amazon.Lambda.Serialization.SystemTextJson.DefaultLambdaJsonSerializer()).Build().RunAsync();
}

public async static Task<APIGatewayProxyResponse> Handler(APIGatewayProxyRequest request)
{
    switch ($"{request.HttpMethod.ToUpper()} {request.Path.ToUpper()}")
    {
        case "GET /products":
            return GetProductsHandler();
        default:
            return new APIGatewayProxyResponse()
            {
                StatusCode = 404
            };
    }
}
Other Information

No response

Acknowledgements
  • I may be able to implement this feature request
  • This feature might incur a breaking change
AWS .NET SDK and/or Package version used

Amazon.Lambda.Annotations

Targeted .NET Platform

.NET 6, .NET 8

Operating System and version

All

Dominant language
C#
Stars
1.7k
Forks
503
Avg merge
1d 18h
Merged PRs (30d)
21

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aws/aws-lambda-dotnet

All issues in aws/aws-lambda-dotnet

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.