https://github.com/cartercommunity/carter.sirennegotiator
A library that extends Carter to handle Siren requests.
https://github.com/cartercommunity/carter.sirennegotiator
asp-net-core carter dotnet-core hypermedia siren
Last synced: about 2 months ago
JSON representation
A library that extends Carter to handle Siren requests.
- Host: GitHub
- URL: https://github.com/cartercommunity/carter.sirennegotiator
- Owner: CarterCommunity
- License: mit
- Created: 2018-04-18T16:40:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-08T13:47:38.000Z (10 months ago)
- Last Synced: 2025-04-21T04:54:27.230Z (about 2 months ago)
- Topics: asp-net-core, carter, dotnet-core, hypermedia, siren
- Language: C#
- Homepage:
- Size: 33.2 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Carter.SirenNegotiator
[](https://ci.appveyor.com/project/ritasker/carter-sirennegotiator/branch/master)
[](https://www.nuget.org/packages/Carter.SirenNegotiator/)
Carter.SirenNegotiator adds content negotiation for [Siren](https://github.com/kevinswiber/siren) requests to your [Carter](https://github.com/CarterCommunity/Carter) API.
## Installation
##### Packaage Manager
`PM> Install-Package Carter.SirenNegotiator`
##### .Net CLI
`$ dotnet add package Carter.SirenNegotiator`
## Usage
Taken from the `sample` project.
#### Create a Response Generator
```c#
public class ActorResponseGenerator : ISirenResponseGenerator
{
public bool CanHandle(Type type)
{
var listType = typeof(IEnumerable);
var classType = typeof(Actor);
return classType.IsAssignableFrom(type) || listType.IsAssignableFrom(type);
}
public Siren Generate(object data, Uri uri)
{
return data is IEnumerable
? Generate((IEnumerable) data, uri)
: Generate((Actor) data, uri);
}
private Siren Generate(IEnumerable actors, Uri uri)
{
var doc = new Siren
{
@class = new [] { "collection" },
entities = new List(),
properties = new { Count = actors.Count() }
};
foreach (var actor in actors)
{
var entity = new Entity
{
@class = new [] { nameof(Actor) },
rel = new [] { "item" },
properties = actor,
links = new List { new Link { href = uri + "/" + actor.Id, rel = new [] { "self" } } }
};
doc.entities.Add (entity);
}
doc.actions = new List (new []{
new Action
{
name = "create-actor",
title = "Create Actor",
method = "POST",
href = uri.ToString(),
type = "application/json",
fields = new List(new[] {new Field {name = "name", type = "text"}, new Field{name = "age", type = "number"}})
}
});
doc.links = new List { new Link { href = uri.ToString(), rel = new [] { "self" } } };
return doc;
}
private Siren Generate(Actor actor, Uri uri)
{
return new Siren
{
@class = new [] { nameof(Actor) },
properties = actor,
links = new List { new Link { href = uri.ToString(), rel = new [] { "self" } } },
actions = new List (new []{
new Action
{
name = "update-actor",
title = "Update Actor",
method = "PUT",
href = uri.ToString(),
type = "application/json",
fields = new List(new[] {new Field {name = "name", type = "text"}, new Field{name = "age", type = "number"}})
},
new Action
{
name = "delete-actor",
title = "Delete Actor",
method = "DELETE",
href = uri.ToString()
}
})
};
}
}
```
This respose generator can handle a list of actors `IList` or a single `Actor`.
#### Register Your Response Generator
```c#
public void ConfigureServices(IServiceCollection services)
{
services.AddSingleton();
services.AddScoped();
services.AddCarter();
}
```
#### Create Your Module
```c#
public class ActorsModule : CarterModule
{
public ActorsModule(IActorProvider actorProvider)
{
Get("/actors/{id:int}", async (req, res, routeData) =>
{
try
{
var person = actorProvider.Get(routeData.As("id"));
await res.Negotiate(person);
}
catch (InvalidOperationException)
{
res.StatusCode = 404;
}
});
}
}
```
#### Send a Request
```bash
$ curl -H "Accept: application/vnd.siren+json" http://localhost:5000/actors/1
```
```json
{
"class": [
"Actor"
],
"properties": {
"Name": "Brad Pitt",
"Id": 1,
"Age": 51
},
"actions": [
{
"name": "update-actor",
"title": "Update Actor",
"method": "PUT",
"href": "http://localhost:5000/actors/1",
"type": "application/json",
"fields": [
{
"name": "name",
"type": "text"
},
{
"name": "age",
"type": "number"
}
]
},
{
"name": "delete-actor",
"title": "Delete Actor",
"method": "DELETE",
"href": "http://localhost:5000/actors/1"
}
],
"links": [
{
"rel": [
"self"
],
"href": "http://localhost:5000/actors/1"
}
]
}
```
## Contributing
Carter.SirenNegotiator is a community project. We invite your participation through issues and pull requests!
## License
Carter.SirenNegotiator is licensed under MIT. Refer to [LICENSE](https://github.com/CarterCommunity/Carter.SirenNegotiator/blob/master/LICENSE) for more information.