Aloji.AspNetCore.HATEOAS
1.0.0
dotnet add package Aloji.AspNetCore.HATEOAS --version 1.0.0
NuGet\Install-Package Aloji.AspNetCore.HATEOAS -Version 1.0.0
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="Aloji.AspNetCore.HATEOAS" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Aloji.AspNetCore.HATEOAS --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Aloji.AspNetCore.HATEOAS, 1.0.0"
#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 Aloji.AspNetCore.HATEOAS as a Cake Addin
#addin nuget:?package=Aloji.AspNetCore.HATEOAS&version=1.0.0
// Install Aloji.AspNetCore.HATEOAS as a Cake Tool
#tool nuget:?package=Aloji.AspNetCore.HATEOAS&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
HATEOAS for Asp.Net Core
How to transform your API in a HATEOAS API?
HATEOASResult implements IActionResult, and his constructor receives two parameters, the object to be returned with links and one func to exceute the real IActionResult.
For this reason it is very easy to transform your API in a HATEOAS API
//
// without links
//
[HttpGet("{id}", Name = RouteNames.Values_GetById)]
public IActionResult Get(int id)
{
var value = this.values.FirstOrDefault(x => x.Id == id);
if (value == null)
return this.NotFound();
return this.Ok(value);
}
//
// with links
//
[HttpGet("{id}", Name = RouteNames.Values_GetById)]
public IActionResult Get(int id)
{
var value = this.values.FirstOrDefault(x => x.Id == id);
if (value == null)
return this.NotFound();
return this.HATEOASResult(value, (v) => this.Ok(v));
}
Configuration
How to setup the models links?
Model:
public class ValueResponse
{
public int Id { get; set; }
public string Value { get; set; }
}
Configure the relationship between the models and the links in Startup.cs
public void ConfigureServices(IServiceCollection services)
{
services.AddHATEOAS(options =>
{
options.AddLink<ValueResponse>("self",
RouteNames.Values_GetById,
HttpMethod.Get,
(x) => new { id = x.Id });
options.AddLink<ValueResponse>("all",
RouteNames.Values_Get,
HttpMethod.Get, null);
options.AddLink<ValueResponse>("delete",
RouteNames.Values_Delete,
HttpMethod.Delete,
(x) => new { id = x.Id });
options.AddLink<ValueResponse>("update",
RouteNames.Values_Update,
HttpMethod.Put,
(x) => new { id = x.Id });
});
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}
Return a instance of HATEOASResult (IActionResult).
// GET api/values
[HttpGet(Name = RouteNames.Values_Get)]
public IActionResult Get()
{
return this.HATEOASResult(this.values, (v) => this.Ok(v));
}
The response generated is
[{
"Id": 1,
"Value": "1",
"_links": [
{
"rel": "self",
"href": "http://localhost:52381/api/Values/1",
"method": "GET"
},
{
"rel": "all",
"href": "http://localhost:52381/api/Values",
"method": "GET"
},
{
"rel": "delete",
"href": "http://localhost:52381/api/Values/1",
"method": "DELETE"
},
{
"rel": "update",
"href": "http://localhost:52381/api/Values/1",
"method": "PUT"
}]
},
]
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Microsoft.AspNetCore.Mvc.Core (>= 2.2.2)
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 |
---|---|---|
1.0.0 | 1,754 | 5/6/2019 |