A C# Simplified RESTful Client, Redis Client and Azure Storage Client in .NET Core

The new .NET Core is a platform framework that has finally come into my life to shake my coding style - now coding in my favorite OS - MacOSX.

Having spent a few hours in coding under .NET Core 1.0 (RC2), I created the RESTme toolkit. I originally was thinking to just create a RESTful client in the first hour, and then decided to make it more powerful by enabling it to communicate with Azure Storage and Redis Cache - why not? Since they are all about requesting and saving data!

General Code Example

//HTTP Restful client (sudo code)
// Get data
rest.Get(requestUrl);
// Save data
rest.Add(paramKey, paramValue);
rest.Post(requestUrl, data);
// Delete data
rest.Delete(requestUrl);
//Azure Storage or Redis ache sudo-code
// Get data
rest.Get<Stream>("/container/filePath");
rest.Get("/container/jsonData");
rest.Get<myObject>("/container/filePath");
// Save data
rest.Post<myObject>("/container/filePath", myObject);
// Delete data
rest.Delete("/container/filePath");

Detailed Examples

Use it as a basic RESTful HTTP Client.
1. //direct string JSON return
2. var rest = new Restme(new Uri("http://freegeoip.net"));
3. var result1 = rest.Get("/json/github.com");
5. //automatic Generic cast
6. var result2 = rest.Get < MyObject > ("/json/github.com");
7. var resultAsync2 = await rest.GetAsync << MyObjecT > ("/json/github.com");
9. //add parameters (Parameters get automatically converted into query string or post form fields)
10. rest.add("q", "github.com");
11. var result3 = rest.Get < MyObject > ("/json");
12. var resultAsync3 = await rest.GetAsync < MyObjecT > ("/json");
14. //supports POST, DELETE, PUT etc.
15. var rest2 = new Restme(new Uri("http://example.com"));
16. rest2.Add("Username", "[email protected]");
17. rest2.Add("Birthday", DateTime.UtcNow);
18. rest2.Post < MyObject > ("/someurl");
20. rest3.PostAsync < MyObject > ("/asyncexample");
23. //supports direct object submission
24. var myObject = new MyObject()
25. {
26. Username = "[email protected]",
27. Birthday = DateTime.UtcNow
28. };
29. var rest3 = new Restme(new Uri("http://example.com"));
30. rest3.Add(myObject);
31. rest3.Post < ExpectedResultObject > ("/directObjectPost");
Use it as an Azure Storage Client,
1. //get blob stream directly
2. var blobStorageConnectionString = "{Your Storage Account Connection String}";
5. var rest = new Restme(blobStorageConnetionString);
8. rest.CreateAzureBlobContainerIfNotExists = true; //do this only if you want to auto create the container
11. //NOTE 1: first segment of the path should always be your container name
14. //NOTE 3: Type T: if it is a type of Stream it will be stored as original Stream as Azure Blob, otherwise it is always saved into JSON format as Azure Blob
17. //NOTE 2: use a type of Stream if you want the original value retrieved from the blob
20. rest.Get < Stream > ("/myContainer/myfilePath");
22. rest.GetAsync < Stream > ("/myContainer/myfilePath");
25. //NOTE: only blob items saved in JSON format is suppported
28. rest.Get < ObjectType > ("/myContainer/myfileObjectInJSONFileFormat");
30. rest.GetAsync < ObjectType > ("/myContainer/myfileObjectInJSONFileFormat");
Use it as a Redis Cache Client,
1. var redisConnectionString = "{Your Redis Cache Connection String}";
2. var rest = new Restme(redisConnectionString);
4. //get cache data (support Generic cast)
5. var cacheResult = rest.Get("home:testKey");
6. var cacheResult2 = rest.Get<bool>("home:testKey2");
7. var cacheResult3 = rest.Get<ObjectType>("home:testKey3");
9. //set cache data
10. rest.Post("home:testKey","value");
11. rest.Post<bool>("home:testKey2",true);
13. var myObject = new ObjectType(); //will be serialized into JSON format and stored as string on redis server
14. rest.Post<ObjectType>("home:testKey3", myObject);

I've made the code open source under MIT on github.