Configuration Reference

Configuration for AspNetConventions is centralized through the options callback. Depending on your project type, you can access these settings via the .AddAspNetConventions() method on IMvcBuilder or the .UseAspNetConventions() method for WebApplication setups.

---

Entry Points

For MVC Controllers and Razor Pages:

builder.Services
    .AddControllersWithViews()
    .AddAspNetConventions(options =>
    {
        // Custom options for MVC and Razor Pages here...
    });

For Minimal APIs:

var api = app.UseAspNetConventions(options =>
    {
        // Convention options for Minimal API here...
    });

MVC vs Minimal APIs

AspNetConventions uses different configuration contexts depending on the type of endpoint you are working with. This separation exists because each endpoint type is integrated at a different stage of the ASP.NET pipeline.

Key Difference:
Each method receives its own instance of AspNetConventionOptions, meaning configurations are not shared automatically between MVC and Minimal APIs.

This allows you to configure each endpoint type independently.

---

Example:

builder.Services
    .AddControllersWithViews()
    .AddAspNetConventions(options =>
    {
        // Applies only to MVC Controllers / Razor Pages
        options.Json.CaseStyle = CasingStyle.SnakeCase;
    });

var app = builder.Build();

var api = app.UseAspNetConventions(options =>
{
    // Applies only to Minimal APIs
    options.Json.CaseStyle = CasingStyle.CamelCase;
});

---

AspNetConventionOptions

Namespace: AspNetConventions.Configuration.Options

The AspNetConventionOptions object is the root configuration container. Every feature within the library is managed through the properties of this class.

Configuration Example:
You can configure multiple features simultaneously to ensure your API remains consistent across all layers.

builder.Services
    .AddControllers()
    .AddAspNetConventions(options =>
    {
        // Disable response metadata
        options.Response.IncludeMetadata = false;

        // Enforce "snake_case" for JSON properties and Route segments
        options.Json.CaseStyle = CasingStyle.SnakeCase;
        options.Route.CaseStyle = CasingStyle.SnakeCase;

        // Register a custom exception mapper
        options.ExceptionHandling.Mappers.Add(new BusinessExceptionMapper());
    });

---

Related Documentation

To see the specific properties available for each feature, refer to their individual reference pages:

• Route Convention Options

• Response Formatting Options

• JSON Serialization Options

• Exception Handling Options