ApiVersioningLib 1.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package ApiVersioningLib --version 1.0.1
                    


                    

                
NuGet\Install-Package ApiVersioningLib -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="ApiVersioningLib" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ApiVersioningLib" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ApiVersioningLib" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ApiVersioningLib --version 1.0.1
                    


                    

                
#r "nuget: ApiVersioningLib, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package ApiVersioningLib@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=ApiVersioningLib&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ApiVersioningLib&version=1.0.1
                    


                            Install as a Cake Tool

ApiVersioningLib

ApiVersioningLib is a lightweight library designed to simplify API versioning for your services. It helps manage and maintain different versions of APIs, allowing for smooth transitions and backward compatibility.

Features

  • Centralized Versioning: Define and manage API versions in a single place.
  • Easy Integration: Quick installation and straightforward usage in your applications.

Installation

You can install the ApiVersioningLib library via the NuGet Package Manager. Run the following command in your Package Manager Console:

Install-Package ApiVersioningLib

or

dotnet add package ApiVersioningLib --version 1.0.0

Usage

To utilize the API versioning features, you can access the version constants defined in the library. Here’s how to implement it in your code:

using ApiVersioningLib;

public class ApiService
{
    public void PrintApiVersions()
    {
        Console.WriteLine($"Account API Version: {ApiVersioningExtensions.AccountApiVersion}");
        Console.WriteLine($"Customer API Version: {ApiVersioningExtensions.CustomerApiVersion}");
        Console.WriteLine($"Transaction API Version: {ApiVersioningExtensions.TransactionApiVersion}");
    }
}

Example

Here's an example of how to incorporate the API versioning in a service:

public class AccountService
{
    public void GetAccountDetails()
    {
        // Use the defined API version for account-related functionality
        string version = ApiVersioningExtensions.AccountApiVersion;

        // Implementation for fetching account details...
        Console.WriteLine($"Fetching account details for API version: {version}");
    }
}

API Versioning Constants

The library provides the following version constants:

  • AccountApiVersion: The version for account-related APIs (currently set to "1.0")
  • CustomerApiVersion: The version for customer-related APIs (currently set to "1.0")
  • TransactionApiVersion: The version for transaction-related APIs (currently set to "1.0")

Feel free to modify the version constants as your APIs evolve over time!

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.3 125 1/20/2025
1.1.2 100 1/20/2025
1.1.1 243 9/27/2024
1.1.0 116 9/27/2024
1.0.1 132 9/26/2024
1.0.0 144 9/26/2024