Skip to content

Fix docs: add Main method signature note #2291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
04cb wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix docs: add Main method signature note #2291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions Libraries/src/Amazon.Lambda.AspNetCoreServer.Hosting/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,28 @@ app.Run();

```

## Important Notes

### Main Method Signature

If you choose to use a `Main` method instead of top-level statements, ensure the method does not accept any parameters. The Lambda runtime attempts to bind the request object to the method parameters, which will cause deserialization errors if the signature includes `string[] args` or other parameters.

```csharp
// Correct - no parameters
public static void Main()
{
var builder = WebApplication.CreateBuilder([]);
// ... rest of the setup
}

// Incorrect - will cause deserialization errors
public static void Main(string[] args)
{
var builder = WebApplication.CreateBuilder(args);
// ... rest of the setup
}
```

## Extension Points

`AddAWSLambdaHosting` accepts an optional `HostingOptions` configuration action that exposes the same customization hooks available in the traditional `AbstractAspNetCoreFunction` base class approach.
Expand Down