Breaking Change
RestRequest.ResponseFormat has been removed because it was too naive. If your requests return XML and specify an XML content type, the XML deserializer will be used and likewise for JSON. If you want to override those deserializers or need to handle a different content type, use the following methods:
var client = new RestClient();
// clear default handlers
client.ClearHandlers();
// add custom handler
// second parameter is instance of IDeserializer
client.AddHandler("application/json", new FunkyDeserializer());
By default the following content types are handled:
- application/xml
- application/json
- text/xml
- text/json (please don’t use this in your apps, supporting it because it’s out there)
By default if the content type returned by your request doesn’t match one of those content types the XML deserializer is used. To register a default handler use client.AddHandler("*", …); You can also remove specific handlers using client.RemoveHandler(contentType);
1.0 Release Update
I know I promised February 24 but a couple bugs and some good feedback items came in and I wanted to resolve them by 1.0. Now I’m going to be on vacation and at MIX so it will likely be shortly after that. Follow @RestSharp for updates.
Progress on RestSharp has been steady lately with the addition of handling for file downloads, gzip/deflate compression handling, JSON request bodies and more. We’re down to just two outstanding issues and then I’ll be ready to christen and release RestSharp 1.0. If you have any features or bugs you want to get included in the first official release, now is the time to report them.
One thing I want to make note of for anyone that’s already using RS is a breaking change that will be committed soon. The ‘BaseUrl’ property that currently resides on RestRequest will be moving to RestClient. RestClient is where you want to be handling configuration that is common amongst many requests (like authorization which is typically pretty standard across an API) and the base URL for an API rarely changes between requests. This change will be checked in tonight.
Once the remaining issues are taken care of and the docs are beefed up I’ll release RestSharp 1.0. My goal is to have done by February 24th but it will likely be sooner than that.
I’ve submitted a session for the MIX10 open call on using REST APIs in your .NET applications. This talk will make extensive use of RestSharp. Even if you’re not going to MIX, you can still vote for the talk. It only takes 20 seconds and you don’t have to provide any personal information. You can vote here.
I just posted over on my personal blog how RestSharp came to be.
The first public commit of RestSharp went up on GitHub just a few minutes ago. I’m hoping to crank out some basic docs and do a downloadable release over the next few days. Stay tuned!
Follow @RestSharp for updates.
