Support development time local HTTP server with Amazon.Lambda.Annotations

[vivainio]

Describe the Feature

When writing serverless functions that are used from behind API gateway (esp. backend to a browser frontend), it's useful to be able to use them on localhost without API Gateway, e.g. through a browser.

This is not currently supported in Amazon.Lambda.Annotations, but is supported in ASP.Net lambda templates https://aws.amazon.com/blogs/developer/running-serverless-asp-net-core-web-apis-with-amazon-lambda/

Similar solutions exist for other platforms, e.g.:

• https://www.serverless.com/plugins/serverless-wsgi
• https://mangum.io/

Describe alternatives you've considered

Use ASPNet.Core template instead of Amazon.Lambda.Annotations

This is a 🚀 Feature Request

[ganeshnj]

I was thinking ways to support local debugging like a localhost server Lambda.Annotations.

I think, we can generate code for a ASP.NET Core Web API app along which has same set of controller actions as customer has specified as LambdaFunctions along with mapping the parameters with ASP.NET Core request parameters.

    public class SimpleCalculator
    {
        private readonly ISimpleCalculatorService _simpleCalculatorService;

        /// <summary>
        /// Default constructor that Lambda will invoke.
        /// </summary>
        public SimpleCalculator(ISimpleCalculatorService simpleCalculatorService)
        {
            this._simpleCalculatorService = simpleCalculatorService;
        }

        [LambdaFunction(Name = "SimpleCalculatorAdd", PackageType = LambdaPackageType.Image)]
        [RestApi(HttpMethod.Get, "/SimpleCalculator/Add")]
        public int Add([FromQuery]int x, [FromQuery]int y)
        {
            return _simpleCalculatorService.Add(x, y);
        }
}

generates

    [Route("SimpleCalculator")]
    [ApiController]
    public class SimpleCalculatorController : ControllerBase
    {
        private readonly SimpleCalculator simpleCalculator;

        public SimpleCalculatorController(SimpleCalculator simpleCalculator)
        {
            this.simpleCalculator = simpleCalculator;
        }

        [HttpGet("Add")]
        public string Add([FromQuery]int x, [FromQuery]int y)
        {
            return simpleCalculator.Add(x, y);
        }
    }

    public class Startup
    {
...
        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            services.AddSingleton(new SimpleCalculator());
        }
...
    }

And now when running locally, you can hit https://localhost:44312/SimpleCalculator/Add?x=1&y=2 from local apps.

[vivainio]

You can avoid generating Controllers by using the new Minimal API approach: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/minimal-apis?view=aspnetcore-6.0

[ganeshnj]

I have not played a lot with minimal APIs, worth considering this option given Lambda Annotations are for .NET 6 or above only.

[normj]

@vivainio If your existing .NET Lambda test tool exposed calling the Lambda functions via the REST endpoint defined in the CloudFormation template would that meet your expectations?

[vivainio]

@normj if that test tools was listening for HTTP requests on localhost and forwarding the calls to the lambda via "proxy" resource, then yes. Similarly to how the aspnet.core template works (unless the recommendation is to use aspnet.core for applications like this)

[normj]

We have released V2 of the Lambda test tool which has support for simulating the API Gateway HTTP experience. Highly recommend using V2 with .NET Aspire integration for an easier setup. The README file for the test tool has details and links to the .NET Aspire integration.