AspNetCore.VersionInfo 2.0.0

AspNetCore.VersionInfo

AspNetCore.VersionInfo is a library to expose information about assembly versions used in your web application. In particular there are three endpoints, which returns:

• a JSON-formatted data (/version/json)
• an HTML user-friendly page (/version/html)
• a nice badge image (/version/badge)

Library offers some in-bundle providers to capture versions information, such as the version of entry assembly or the version of the common language runtime. A typical JSON output is:

{
    "RuntimeInformation.FrameworkDescription":".NET 6.0.8",
    "EntryAssemblyVersion":"2.5.0.0",

    ...
}

Moreover it is possible create a specific class to collect additional data as described in Providers section.

🧰 Supported Platforms

This library currently targets net8.0

📦 Download

Prerelease packages are on GH Packages

Release packages are on Nuget

🚀 Online Demo

	URL
Windows Web App	https://aspnetcoreversioninfo-demo.azurewebsites.net
Windows HTML Endpoint	/version/html
Windows JSON Endpoint	/version/json
Windows Badge Endpoint	/version/badge
Linux Web App	https://aspnetcoreversioninfo-linux-demo.azurewebsites.net
Linux HTML Endpoint	/version/html
Linux JSON Endpoint	/version/json
Linux Badge Endpoint	/version/badge

⭐ Getting Started

Startup.cs

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddVersionInfo()
            .With<ClrVersionProvider>()
            .With<AssemblyVersionProvider>();
    }

    public void Configure(IApplicationBuilder app)
    {
        app.UseRouting();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapVersionInfo();
        });
    }
}

🔌 Providers

Library is based on following types:

• Providers, that read information and return data in a dictionary
• Collector, that aggregates all data from providers and exposes to endpoints.

A Collector implementation is already included in AspNetCore.VersionInfo package, and usually its default implementation is valid for all scenarios.

Instead, in order to enrich data gathered from library, multiple custom providers could be developed, implementing custom classes inherited from IInfoProvider interface.

To show providers' information, they have to be configured in ConfigureServices declaration, using .With<IInfoProvider> extension method.

In-bundle providers

AspNetCore.VersionInfo package includes following providers:

🔧 Options

MapVersionInfo extension method accepts an optional VersionInfoOptions argument to change default URLs:

public void Configure(IApplicationBuilder app)
{
    app.UseRouting();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapVersionInfo(o =>
        {
            o.HtmlPath = CUSTOM_HTML_URL;
            o.ApiPath = CUSTOM_JSON_URL;
        });
    });
}

🖼 Badges

Badge image can be obtained with url

/version/badge/{versionInfoId}

where {versionInfoId} is a key returned by providers.

Moreover endpoint accepts following parameters in querystring:

• label: it's the name to show in the image
• icon: the source type and slug for the icon separated by two underscore characters (__) such as simpleicons__linux. In this version only Simple Icons type is supported; you can find a list of slugs here. Icon color is always white.
• color: a string as defined in the colors table or a custom colors in hexadecimal, RGB, HSL.

💿 Examples

🔑 Security

Enable Endpoint only in Development mode

In order to enable AspNetCore.VersionInfo only in the development environment, change Configure method

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    ...
    
    app.UseEndpoints(endpoints =>
    {
        if (env.IsDevelopment())
        {
            endpoints.MapVersionInfo();
        }
    });
    
    ...
}

Authorization Policy on endpoint

public void ConfigureServices(IServiceCollection services)
{
    ...
    
    services.AddAuthorization(cfg =>
    {
        cfg.AddPolicy(name: Constants.VERSIONINFO_USER_POLICY, cfgPolicy =>
        {
            cfgPolicy.AddRequirements().RequireAuthenticatedUser();
            cfgPolicy.AddAuthenticationSchemes(Constants.COOKIE_SCHEME);
        });
    });
    
    ...
}


public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    ...
    
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapVersionInfo().RequireAuthorization(Constants.VERSIONINFO_USER_POLICY); ;
    });
    
    ...
}

For more information, you can inspect Authentication example.

📄 License

AspNetCore.VersionInfo is Apache-2.0 licensed