Badge Generator Library

This is a simple .NET library that can generate SVG badges dynamically. The badges can contain text as well as icons (through image URLs) and are customizable in terms of size, padding and colors.

Name	Version	Downloads
BadgeGenerator
BadgeGenerator.AspNetCore.HealthChecks.Badge

Installation

To include this library in your project, you can install one of the two "variants":

• The classic BadgeGenerator providing raw capabilities for generating badge SVGs:

dotnet add package BadgeGenerator

• Alternatively, you can install the BadgeGenerator.AspNetCore.HealthChecks.Badge version which provides a middleware extension that returns a badge containing your application's current health status:

dotnet add package BadgeGenerator.AspNetCore.HealthChecks.Badge

Usage

Creating a Badge

To create a badge, you need to define the sections and metadata, and then call the CreateBadgeSvg method to generate the SVG.

Example

Here is an example of how to create a badge with two sections:

using BadgeGenerator;

List<BadgeSection> badgeSections = new()
{
    new()
    {
        Content = new Uri("https://example.com/healthy.png"),
        IconSize = 12,
        BackgroundColor = "#555"
    },
    new()
    {
        Content = "Status",
        ForegroundColor = "#fff",
        BackgroundColor = "#555"
    },
    new()
    {
        Content = "Healthy",
        ForegroundColor = "#fff",
        BackgroundColor = "rgb(11, 97, 42)"
    }
};

var badgeSvg = BadgeCreator.CreateBadgeSvg(badgeSections, new BadgeMetadata { Height = 20, Padding = 10 });
Console.WriteLine(badgeSvg);

This will output the SVG of the badge with three sections: one with a healthy.png icon, another with the text "Status" and the third one with text "Healthy". You can customize the badge's size and padding by passing a BadgeMetadata object:

var metadata = new BadgeMetadata
{
    Height = 28,
    Padding = 12
};

Health Checks endpoint

You can install AspNetCore.HealthChecks.Badge and register an UseHealthBadge() middleware somewhere in your app's pipeline.

using AspNetCore.HealthChecks.Badge;

app.UseHealthBadge("healthz");

The result could, when an HTTP request is sent towards /healthz, look something like this for various health statuses:

Contributing

Got suggestions, found a bug or would like to contribute? If so, feel free to create issues or pull requests. Please do make sure to try to write clear and concise commit messages.

Support

If you find this project helpful and would like to show support, you can do so via PayPal.me.

License

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