Attrify 0.0.0.2

dotnet add package Attrify --version 0.0.0.2                
NuGet\Install-Package Attrify -Version 0.0.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="Attrify" Version="0.0.0.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Attrify --version 0.0.0.2                
#r "nuget: Attrify, 0.0.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.
// Install Attrify as a Cake Addin
#addin nuget:?package=Attrify&version=0.0.0.2

// Install Attrify as a Cake Tool
#tool nuget:?package=Attrify&version=0.0.0.2                

Attrify

Build The Standard The Standard - COMPLIANT The Standard Community NuGet version (Attrify) NuGet downloads (Attrify)

A library to enhancing REST API functionality through attributes.

Attributes in this library


1. InvisibleApi

The Attrify - Invisible API is a solution designed to hide specific API endpoints, primarily for acceptance testing purposes. Developers can uses the [invisibleApi] attribute to mark Controllers or Actions as invisible, eliminating the need for manual endpoint configuration in middleware. It also introduces an additional security layer by requiring that an authenticated user must belong to a certain role to access the endpoint. If these conditions are not met, the middleware intercepts the request and returns a 404 Not Found response, making the endpoint invisible to unauthorized users.


2. DeprecatedApi

The Deprecated API solution is designed to help developers manage the lifecycle of API endpoints by signaling when they are outdated or set to be decommissioned. By using the Deprecated API Attribute and its accompanying Middleware, developers can mark API endpoints as deprecated and provide users with advance notice of when an API will be removed. This includes a "Sunset" date, which specifies when the API will no longer be available, and a warning message encouraging users to migrate to newer versions. Additionally, developers can provide a link to migration resources to assist users in transitioning. Once the sunset date passes, the middleware automatically returns a 410 Gone HTTP status code to indicate that the API is no longer available, ensuring clear communication and minimizing disruption for consumers. This solution helps ensure that users are well-informed and have sufficient time to adapt, making the deprecation process smooth and reducing the impact on API consumers.


Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible. 
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.

Version Downloads Last updated
0.0.0.2 85 11/24/2024
0.0.0.1 51 11/24/2024

Initial release of the Attrify library.