Dynamic proxy client generation for Nancy using Nancy.Rest.Module.
A server using Nancy & Nancy.Rest.Module.
It is recommended you read the Nancy.Rest.Module documentation to understand how the server mount the services before continuing reading.
- Add Nancy.Rest.Client and Nancy.Rest.Annotations to your client project.
Or
- Add the Nuget package Nancy.Rest.Client
Add your server models and interface with the method signatures to use.
####Your Server signatures:
namespace Nancy.Rest.ExampleServer
{
[RestBasePath("/api")]
public interface IExample
{
[Rest("Person", Verbs.Get)]
List<Person> GetAllPersons();
[Rest("Person/{personid}", Verbs.Get)]
Person GetPerson(int personid);
[Rest("Person", Verbs.Post)]
bool SavePerson(Person person);
[Rest("Person/{personid}", Verbs.Delete)]
bool DeletePerson(int personid);
}
}####Your Server Models
namespace Nancy.Rest.ExampleServer
{
public class Person
{
public string FirstName { get; set; }
public string LastName { get; set; }
[Level(1)]
public bool IsProgrammer { get; set; }
[Tags("Attr")]
public List<string> Attributes { get; set; }
}
}namespace Nancy.Rest.ExampleClient
{
public class Example
{
public void Run()
{
IExample server=ClientFactory.Create<IExample>("http://yourserver/api"); `
List<Person> persons=server.GetPersons();
}
}
}##Advanced Usage
###Transversal Filtering
Nancy.Rest.Client includes this interface.
using System.Collections.Generic;
namespace Nancy.Rest.Client.Interfaces
{
public interface IFilter<T>
{
T FilterWithLevel(int level);
T FilterWithTags(IEnumerable<string> tags);
T FilterWithLevelAndTags(int level, IEnumerable<string> tags);
}
}Create a new interface in your client that includes, both, IFilter interface and your server interface.
namespace Nancy.Rest.ExampleClient
{
public interface IExampleWithFiltering : IExample, IFilter<IExample>
{
}
}Then you can use the transversal filtering capabilities of the server like this:
namespace Nancy.Rest.ExampleClient
{
public class Example
{
public void Run()
{
IExampleWithFiltering server=ClientFactory.Create<IExampleWithFiltering>("http://yourserver/api"); `
//Per example, you can ask the server to not serialize any property with level bigger than the number provided.
//Here we can filter the IsProgrammer property using levels.
List<Person> persons=server.FilterWithLevel(0).GetPersons();
//Or remove the Attributes property using Tags.
List<Person> persons=server.FilterWithTags(new string[] { "Attr"}).GetPersons();
}
}
}###Controlable deserialization
Imagine you have your poco models from the server, but you need to add some properties, methods or INotifyPropertyChanged to that objects, you create a child class from the model, and add all those things. The problem is, the deserialzer will deserialize your poco model, so you have to create a new child class, and copy all properties to your child. Nancy.Rest.Client have the capability of deserializing the objects to child objects.
####Client model
namespace Nancy.Rest.ExampleClient
{
public class ClientPerson : Person
{
public bool IsSuperman { get; set; }
public void DoSomeNastyThings()
{
//Kidding
}
}
}####Example
namespace Nancy.Rest.ExampleClient
{
public class Example
{
public void Run()
{
Dictionary<Type,Type> mappings=new Dictionary<Type,Type>();
//Here we add the mapping, we want every person to be deserialized as ClientPerson
mappings.Add(typeof(Person), typeof(ClientPerson));
IExample server=ClientFactory.Create<IExample>("http://yourserver/api", mappings); `
//Here is your list of client persons
List<ClientPerson> persons=server.GetPersons().Cast<ClientPerson>.ToList();
}
}
}##WARNING
THIS IS AN BETA VERSION, so far it works on my machine ;)
- Fill the blanks :P
1.4.3-Beta: Removed bugs, published nugets. 1.4.3-Alpha: First Release
- Maximo Piva - maxpiva
This project is licensed under the MIT License - see the LICENSE.md file for details