Odex.AspNetCore.Generators.OidGen 0.1.1

🔐 Odex.AspNetCore.Generators.OidGen

Unique ID Generator for ASP.NET Core
Simple, flexible, and customizable unique ID generation library

📦 Overview

Odex.AspNetCore.Generators.OidGen (O'shabi Unique ID Generator) is a lightweight, dependency-injection-friendly library for generating unique identifiers in ASP.NET Core applications. It provides a clean interface for creating IDs with digits, characters, mixed characters, prefixes, suffixes, and mask-based formats — all with optional special character support.

Key Features:

• Numeric IDs – Generate random digit-only strings.
• Character IDs – Generate alphabetic IDs with uppercase/lowercase control.
• Mixed IDs – Combine digits, letters, and optional special characters.
• Prefix/Suffix – Conveniently attach prefixes or suffixes to generated IDs.
• Mask Formatting – Define custom patterns using placeholders.
• Configurable Special Characters – Customize the set of allowed special characters via OidOptions.
• DI-Ready – Register with a single extension method in your Program.cs.

🚀 Getting Started

Prerequisites

• .NET 9.0 SDK or later
• An ASP.NET Core project

Installation

The library is published as a NuGet package:

dotnet add package Odex.AspNetCore.Generators.OidGen

Or use the Package Manager Console:

Install-Package Odex.AspNetCore.Generators.OidGen

Basic Setup

1. Register OidGen in Program.cs

using Odex.AspNetCore.Generators.OidGen;

var builder = WebApplication.CreateBuilder(args);

// Add with default options
builder.Services.AddOidGen();

// Or configure custom options
builder.Services.AddOidGen(options =>
{
    options.Placeholder = '*';
    options.SpecialChars = "!@#$%";
});

var app = builder.Build();

2. Inject and Use IOidGen in a Controller or Service

using Microsoft.AspNetCore.Mvc;
using Odex.AspNetCore.Generators.OidGen.Interfaces;

[ApiController]
[Route("api/[controller]")]
public class OrdersController : ControllerBase
{
    private readonly IOidGen _oidGen;

    public OrdersController(IOidGen oidGen)
    {
        _oidGen = oidGen;
    }

    [HttpPost]
    public IActionResult CreateOrder()
    {
        // Generate a unique order ID
        var orderId = _oidGen.WithPrefix(12, "ORD-", useSpecialCharacters: false);
        // Result example: ORD-x7K9mP2qR5nL
        
        return Ok(new { OrderId = orderId });
    }
}

✨ Features

🚀 Usage Examples

Generate a 10-Digit Numeric ID

var numericId = _oidGen.Digit(10);
// Result: "8472910536"

Generate an 8-Character Uppercase-Only ID

var upperId = _oidGen.Character(8, uppercaseOnly: true);
// Result: "KXMVRQPT"

Generate a 12-Character Mixed ID with Special Characters

var mixedId = _oidGen.Mixed(12, useSpecialCharacters: true);
// Result: "aB3-xK9_mP2q"

Generate an ID with a Prefix

var prefixedId = _oidGen.WithPrefix(8, "USR-", useSpecialCharacters: false);
// Result: "USR-a3Fk9M2x"

Generate an ID with a Suffix

var suffixedId = _oidGen.WithSuffix(6, "-2024", useSpecialCharacters: false);
// Result: "xK9mP2-2024"

Generate an ID Using a Mask

var maskedId = _oidGen.Formatted("PROD-###-####", placeholder: '#');
// Result: "PROD-a3F-k9M2"

Custom Mask with Different Placeholder

// Using default options (Placeholder = '#')
var phoneId = _oidGen.Formatted("+1 (###) ###-####");
// Result: "+1 (473) 829-1056"

// Or with custom placeholder if configured
var customId = _oidGen.Formatted("TXN-***-***", placeholder: '*');
// Result: "TXN-a3F-k9M"

Complete Service Example

public class UserService
{
    private readonly IOidGen _oidGen;

    public UserService(IOidGen oidGen)
    {
        _oidGen = oidGen;
    }

    public string GenerateUserId()
    {
        return _oidGen.WithPrefix(10, "USER-");
        // Result: "USER-a3Fk9M2xR5"
    }

    public string GenerateApiKey()
    {
        return _oidGen.Formatted("key_####################", useSpecialCharacters: false);
        // Result: "key_a3Fk9M2xR5nLpT8sWqY"
    }

    public string GenerateOrder[Odex.AspNetCore.Generators.OidGen.csproj](Odex.AspNetCore.Generators.OidGen.csproj)Number()
    {
        return _oidGen.Formatted("ORD-####-####", useSpecialCharacters: false);
        // Result: "ORD-a3Fk-9M2x"
    }
}

📂 Namespace Map

🤝 Contributing

Contributions are welcome! Please follow the standard GitHub flow:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit changes (git commit -m 'Add amazing feature')
4. Push to branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

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

Built with ❤️ - A clean and simple ID generation for ASP.NET Core