Apikee 1.0.2

.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 Apikee --version 1.0.2
                    


                    

                
NuGet\Install-Package Apikee -Version 1.0.2
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="Apikee" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Apikee" Version="1.0.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Apikee" />
                    


                            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 Apikee --version 1.0.2
                    


                    

                
#r "nuget: Apikee, 1.0.2"
#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 Apikee@1.0.2
#: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=Apikee&version=1.0.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Apikee&version=1.0.2
                    


                            Install as a Cake Tool

ApiKee .NET SDK

ApiKee is a lightweight .NET package that provides local and server-side API key validation for your ASP.NET Core applications. It offers two modes of validation:

  • Local Validation: Validates API keys stored in the app's configuration.
  • Server Validation (Premium Feature): Validates API keys against an external service using an endpoint ID and API key.

Features

  • Simple attribute-based validation.
  • Local API key validation from app settings.
  • Server validation using external API.

Installation

Install the package via NuGet:

dotnet add package Apikee

Usage

Local API Key Validation

Add the [ApiKee("local-key")] attribute to your controller or action to validate the API key using the app's configuration.

[ApiController]
[Route("api/[controller]")]
public class ExampleController : ControllerBase
{
    [HttpGet("local")]
    [ApiKee("local-key-1")] // Local validation
    public IActionResult GetLocalData()
    {
        return Ok(new { message = "Locally validated API Key is valid!" });
    }
}

Server API Key Validation (Premium)

Add the [ApiKee("endpoint_id")] attribute to your controller or action for server-side validation.

[ApiController]
[Route("api/[controller]")]
public class ExampleController : ControllerBase
{
    [HttpGet]
    [ApiKee("endpoint_123")] // Server validation
    public IActionResult GetExampleData()
    {
        return Ok(new { message = "Server-validated API Key is valid!" });
    }
}

Configuration

In your appsettings.json, add the local keys and server configuration:

{
    "LocalApiKeys": [
    "local-key-1",
    "local-key-2"
    ],
    "ApiKeeSite": "https://external-validation-api.com/validate",
    "ApiKeeKey": "your-external-api-key"
}
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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Added server-side API key validation feature.