Franz.Common.Http.Headers 2.3.3

Franz.Common.Http.Headers

HTTP, identity, and service integration for the Franz.Common framework on .NET 10.

Overview

The Franz.Common.Http.Headers package provides HTTP, identity, and service integration within Franz.Common. It is designed to compose with the rest of the framework rather than imposing unrelated infrastructure choices on every application.

Installation

dotnet add package Franz.Common.Http.Headers

Design principles

• Explicit composition: register only the capabilities the application needs.
• Clear boundaries: keep domain and application contracts independent from provider-specific infrastructure where the package's role permits it.
• Predictable behavior: make configuration, failure modes, and lifecycle ownership visible rather than relying on hidden conventions.
• Operational readiness: validate security, resilience, diagnostics, and compatibility for the actual deployment environment.

Usage and configuration

Follow the package-specific setup, configuration, and code examples below. Only configure external services when this package requires them, and keep secrets outside source control.

Package-specific guide

A library within the Franz Framework designed to streamline the management, validation, and processing of HTTP headers in ASP.NET Core applications. This package provides custom model binders, attributes, and utilities for working with headers, ensuring consistency and efficiency across applications.

Features

• Header Validation:
  • HeaderRequiredAttribute for enforcing required headers on API actions.
  • HeaderRequiredActionConstraint for conditional routing based on headers.
• Custom Model Binding:
  • ComplexModelBinder and HeaderComplexModelBinderProvider for advanced header parsing and mapping.
• HTTP Context Utilities:
  • HeaderContextAccessor for simplified access to HTTP header data.
• Dependency Injection:
  • ServiceCollectionExtensions for easily integrating header-related services.

Version Information

Current Version: v2.3.3

• Part of the private Franz Framework ecosystem.

Dependencies

This package relies on:

• Microsoft.AspNetCore.Mvc.Core (2.2.5): Provides core MVC functionality for headers.
• Newtonsoft.Json (13.0.3): Advanced JSON serialization for complex header handling.
• Franz.Common.Headers: Core header utilities.
• Franz.Common.Serialization: Serialization utilities for advanced header operations.

Installation

From Private Azure Feed

Since this package is hosted privately, configure your NuGet client:

dotnet nuget add source "https://your-private-feed-url" \
  --name "AzurePrivateFeed" \
  --username "YourAzureUsername" \
  --password "YourAzurePassword" \
  --store-password-in-clear-text

Install the package:

dotnet add package Franz.Common.Http.Headers  

Usage

1. Enforce Required Headers

Use HeaderRequiredAttribute to enforce the presence of specific headers:

using Franz.Common.Http.Headers.Extensions;

[HttpGet]
[HeaderRequired("X-Custom-Header")]
public IActionResult Get()
{
    return Ok("Header is present");
}

2. Advanced Header Parsing

Leverage ComplexModelBinder to parse and bind headers to complex objects:

using Franz.Common.Http.Headers.Extensions;

public class CustomHeaderModel
{
    public string Key { get; set; }
    public string Value { get; set; }
}

[HttpPost]
public IActionResult Post([ModelBinder(typeof(ComplexModelBinder))] CustomHeaderModel headerModel)
{
    return Ok(headerModel);
}

3. HTTP Context Access

Simplify access to header data using HeaderContextAccessor:

using Franz.Common.Http.Headers.Extensions;

var customHeader = contextAccessor.GetHeaderValue("X-Custom-Header");

4. Register Header Utilities

Use ServiceCollectionExtensions to register all header-related utilities:

using Franz.Common.Http.Headers.Extensions;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddHeaderUtilities(); // Registers header-related services and utilities
    }
}

Integration with Franz Framework

The Franz.Common.Http.Headers package integrates seamlessly with:

• Franz.Common.Headers: Core header utilities and extensions.
• Franz.Common.Serialization: Enhances serialization for complex header processing.

Ensure these dependencies are installed to fully leverage the library's capabilities.

Contributing

This package is part of a private framework. Contributions are limited to the internal development team. If you have access, follow these steps:

1. Clone the repository. @ https://github.com/bestacio89/Franz.Common/
2. Create a feature branch.
3. Submit a pull request for review.

License

This library is licensed under the MIT License. See the LICENSE file for more details.

Changelog

Version 1.2.65

• Upgrade version to .net 9

Version 1.3

• Upgraded to .NET 9.0.8
• Added new features and improvements
• Separated business concepts from mediator concepts
• Now compatible with both the in-house mediator and MediatR

Version 1.6.20

• Updated to .NET 10.0

v2.0.1 – Internal Modernization

• Messaging and infrastructure refactored for async, thread-safety, and modern .NET 10 patterns.
• All APIs remain fully backward compatible.
• Tests, listeners, and pipeline components modernized.

Dependency maintenance — October 2026

This project's dependency references were reviewed and updated as part of the repository-wide .NET 10 maintenance pass. The intended target framework and public API remain unchanged. Verify the resolved direct and transitive dependency graph through the repository's dependency validation workflow before publishing. See the central dependency upgrade record.