HateoasNet

HateoasNet is a lightweight library that provides a simple and efficient way to implement HATEOAS (Hypermedia as the Engine of Application State) in .NET C# projects. With HateoasNet, you can easily define and generate hypermedia links within your API responses, improving the discoverability and usability of your API.

Table of Contents

• Installation
• Features
• Usage Wiki
• Examples
• Contributing
• License

Installation

The library targets NetCoreApp3.1 and Net Framework 4.72 and can be installed via NuGet package manager or by manually adding the package reference to your .NET Core project file.

NuGet Package Manager

1. Open your project in Visual Studio
2. Right-click on the project and select "Manage NuGet Packages..."
3. In the "Browse" tab, search for "HateoasNet"
4. Select the package and click "Install"

Or in the project directory, run one of the following command:

.NET Core CLI

dotnet add package HateoasNet

.NET Framework

Install-Package HateoasNet

Features

• Flexible and customizable link generation
• Easy integration with existing Web API projects
• Lightweight and performance-focused design
• Provides a fluent API for defining and generating links

Usage Wiki

Check out the wiki in the project's GitHub repository to see HateoasNet usage defails and instructions.

Examples

To see HateoasNet in action, check out the examples directory in the project's GitHub repository. These examples demonstrate how to use HateoasNet in sample scenarios.

Contributing

Contributions to the project are always welcome! If you find a bug or have a feature request, please open an issue on the GitHub repository. If you'd like to contribute code, please fork the repository and submit a pull request.

Code of conduct

Please note we have a Code of conduct, please follow it in all your interactions with the project.

License

HateoasNet is licensed under the MIT License.