https://github.com/salem84/aspnetcore.versioninfo
Get version information of your .NET 6 web application with this simple endpoint middleware
https://github.com/salem84/aspnetcore.versioninfo
aspnet-core dotnet-core endpoint hacktoberfest middleware versioning
Last synced: 6 months ago
JSON representation
Get version information of your .NET 6 web application with this simple endpoint middleware
- Host: GitHub
- URL: https://github.com/salem84/aspnetcore.versioninfo
- Owner: salem84
- License: apache-2.0
- Created: 2021-02-13T21:54:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-14T23:41:35.000Z (7 months ago)
- Last Synced: 2025-03-30T00:11:33.974Z (7 months ago)
- Topics: aspnet-core, dotnet-core, endpoint, hacktoberfest, middleware, versioning
- Language: C#
- Homepage:
- Size: 1.62 MB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](http://www.nuget.org/packages/AspNetCore.VersionInfo)  [](https://github.com/salem84/AspNetCore.VersionInfo/blob/master/LICENSE) [](https://sonarcloud.io/dashboard?id=salem84_AspNetCore.VersionInfo)
[](https://sonarcloud.io/dashboard?id=salem84_AspNetCore.VersionInfo)
[](https://sonarcloud.io/dashboard?id=salem84_AspNetCore.VersionInfo)
# 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:
```js
{
"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](#providers) section.
## 🧰 Supported Platforms
This library currently targets `net8.0`
## 📦 Download
Prerelease packages are on [GH Packages](https://github.com/salem84?tab=packages&repo_name=AspNetCore.VersionInfo)
Release packages are on [Nuget](http://www.nuget.org/packages/AspNetCore.VersionInfo)
## 🚀 Online Demo
| | URL |
|---|:-----:|
| **Windows Web App**| https://aspnetcoreversioninfo-demo.azurewebsites.net |
| **Windows HTML Endpoint** | [/version/html](https://aspnetcoreversioninfo-demo.azurewebsites.net/version/html) |
| **Windows JSON Endpoint** | [/version/json](https://aspnetcoreversioninfo-demo.azurewebsites.net/version/json) |
| **Windows Badge Endpoint** | [](https://aspnetcoreversioninfo-demo.azurewebsites.net/version/badge/RuntimeInformation.RuntimeIdentifier?color=BrightGreen&label=os) |
| | |
| **Linux Web App**| https://aspnetcoreversioninfo-linux-demo.azurewebsites.net |
| **Linux HTML Endpoint**| [/version/html](https://aspnetcoreversioninfo-linux-demo.azurewebsites.net/version/html) |
| **Linux JSON Endpoint**| [/version/json](https://aspnetcoreversioninfo-linux-demo.azurewebsites.net/version/json) |
| **Linux Badge Endpoint** | [](https://aspnetcoreversioninfo-linux-demo.azurewebsites.net/version/badge/RuntimeInformation.RuntimeIdentifier?color=Red&label=os&icon=simpleicons__debian) |
## ⭐ Getting Started
### Startup.cs
```csharp
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddVersionInfo()
.With()
.With();
}
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` extension method.
### In-bundle providers
_AspNetCore.VersionInfo_ package includes following providers:
| Provider | Keys | Description |
| - | - | - |
| AssemblyVersionProvider | `EntryAssembly`
`EntryAssemblyFullName`
`EntryAssemblyLocation`
`EntryAssemblyDirectoryPath`
`EntryAssemblyFileVersion`
`EntryAssemblyClrVersion`
`EntryAssemblyCreationDate`
`EntryAssemblyLastModifiedDate` | Version and main properties of entry assembly |
| ClrVersionProvider | `RuntimeInformation.FrameworkDescription`
`RuntimeInformation.OsDescription`
`RuntimeInformation.OsArchitecture`
`RuntimeInformation.ProcessArchitecture`
`RuntimeInformation.RuntimeIdentifier` | Version of the common language runtime and .NET installation on which the app is running |
| AppDomainAssembliesVersionProvider | `` | Version of assemblies loaded in App Domain |
| EnvironmentProvider | `Environment.Uptime`
`Environment.OSVersion`
`Environment.IsOsWindows`
`Environment.Is64BitOperatingSystem`
`Environment.Is64BitProcess`
`Environment.ProcessorCount`
`Environment.MachineName`
`Environment.SystemDirectory`
`Environment.WorkingDirectory`
`Environment.CommandLine`
`Environment.DotNetVersion` | Environment properties |
| EnvironmentVariablesProvider | ``-`` | Environment variables |
## 🔧 Options
`MapVersionInfo` extension method accepts an optional `VersionInfoOptions` argument to change default URLs:
```csharp
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](https://simpleicons.org/) type is supported; you can find a list of slugs [here](https://github.com/simple-icons/simple-icons/blob/develop/slugs.md). Icon color is always white.
* `color`: a string as defined in the colors table or a custom colors in hexadecimal, RGB, HSL.
| Color | String |
| - | - |
| | BrightGreen |
|  | Green |
|  | Yellow |
|  | YellowGreen |
|  | Orange |
|  | Red |
|  | Blue |
|  | Gray |
|  | LightGray |
## 💿 Examples
| Name | Notes | Repository |
| - | - | - |
| Basic | Simple .NET 6 WebApplication with built-in endpoints (published in [demo site](https://aspnetcoreversioninfo-demo.azurewebsites.net)) | [💾](./samples/Basic) |
| CustomOptions | WebApplication with custom configuration for endpoint URLs | [💾](./samples/CustomOptions) |
| Minimal | WebApplication using Minimal API | [💾](./samples/Minimal) |
| Authentication | WebApplication leverages the ASP.NET Core Authentication/Authorization features to easily restrict access | [💾](./samples/Authentication) |
## 🔑 Security
### Enable Endpoint only in Development mode
In order to enable _AspNetCore.VersionInfo_ only in the development environment, change `Configure` method
```cs
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
...
app.UseEndpoints(endpoints =>
{
if (env.IsDevelopment())
{
endpoints.MapVersionInfo();
}
});
...
}
```
### Authorization Policy on endpoint
```cs
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](./samples/Authentication).
## 📄 License
_AspNetCore.VersionInfo_ is [Apache-2.0 licensed](./LICENSE.md)