ApiLocksmith.Core 1.0.1

dotnet add package ApiLocksmith.Core --version 1.0.1
                    
NuGet\Install-Package ApiLocksmith.Core -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="ApiLocksmith.Core" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ApiLocksmith.Core" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="ApiLocksmith.Core" />
                    
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 ApiLocksmith.Core --version 1.0.1
                    
#r "nuget: ApiLocksmith.Core, 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 ApiLocksmith.Core@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=ApiLocksmith.Core&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=ApiLocksmith.Core&version=1.0.1
                    
Install as a Cake Tool

ApiLocksmith.Core

The ApiLocksmith.Core library allows you to add ApiKey-based authentication to your minimal APIs built with ASP.NET Core. It provides a flexible and easy-to-use solution for securing your APIs.

Usage

To use ApiLocksmith.Core, follow these steps:

  1. Install the NuGet package:

    dotnet add package ApiLocksmith.Core
    
  2. Configure the ApiKeyOptions inside the appsettings.json:

    {
      "Logging": {
        "LogLevel": {
          "Default": "Information",
          "Microsoft.AspNetCore": "Warning"
        }
      },
      "AllowedHosts": "*",
      "ApiKeySettings": {
        "ApiKey": "MySecretApiKey",
        "ApiKeyHeaderName": "x-api-key",
        "ApiKeySchemeName": "ApiKey"
      }
    }
    
  3. Add this to your Program.cs:

    builder.Services.AddApiKeyAuthenticationScheme(builder.Configuration, "ApiKeySettings");
    
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 (1)

Showing the top 1 NuGet packages that depend on ApiLocksmith.Core:

Package Downloads
ApiLocksmith.Swagger.FastEndpoints

A C# library providing Swagger integration with FastEndpoints for APIs secured with ApiKey-based authentication in ASP.NET Core.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 468 12/26/2023
1.0.0 572 12/5/2023