ApiKee 1.0.6

.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.6
                    


                    

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


                            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.6
                    


                    

                
#r "nuget: ApiKee, 1.0.6"
#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.6
#: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.6
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ApiKee&version=1.0.6
                    


                            Install as a Cake Tool

ApiKee

ApiKee is a .NET package that provides endpoint protection using API keys with options for local and server validation. It also integrates API key security with Swagger documentation.

Installation

  1. Add ApiKee to your project.
  2. Install necessary NuGet packages.

Usage

  1. Register the services in your project:

    services.AddApiKee();
services.AddApiKeeSwagger();

  2. Configure your API keys in appsettings.json:

    {
  "ApiKeys": ["local-key"],
  "ApiKeeSite": "your-site",
  "ApiKeeKey": "your-site-key"
}

  3. Use [ApiKee] attribute to protect endpoints:

    [ApiKee]
public IActionResult ProtectedEndpoint() => Ok("Protected content");

For server validation, specify the endpoint ID:

[ApiKee("your-endpoint-id")]
public IActionResult ServerProtectedEndpoint() => Ok("Server protected content");

This setup makes `ApiKee` a standalone package that can be added to any .NET project. Integration is achieved by calling the `AddApiKee()` and `AddApiKeeSwagger()` methods on `IServiceCollection`. Let me know if you need any additional customization or explanation!
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.