Attrify 0.0.0.1

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.