Simple REST client for iOS and Mac.
SVHTTPRequest lets you easily interact with RESTful (GET, POST, DELETE, PUT) web APIs. It is blocked-based, uses
NSURLConnection, ARC, as well as
NSJSONSerializationto automatically parse JSON responses.
SVHTTPRequest features:
GET,
POST,
PUT,
DELETE,
HEADand download requests.
response(
NSObjectif JSON, otherwise
NSData),
NSHTTPURLResponseand
NSErrorobjects.
basePathand basic authentication signing when using
SVHTTPClient.
multipart/form-dataparameters in POST and PUT requests.
Add
pod 'SVHTTPRequest'to your Podfile or
pod 'SVHTTPRequest', :headif you're feeling adventurous.
If your project doesn't use ARC: you must add the
-fobjc-arccompiler flag to
SVHTTPRequest.mand
SVHTTPClient.min Target Settings > Build Phases > Compile Sources.
SVHTTPRequest/SVHTTPRequestfolder into your project.
#import "SVHTTPRequest.h"(this will import
SVHTTPClientas well)
(see sample Xcode project in
/Demo)
The easiest way to make a request is using the
SVHTTPRequestconvenience methods:
[SVHTTPRequest GET:@"https://api.github.com/repos/samvermette/SVHTTPRequest" parameters:nil completion:^(id response, NSHTTPURLResponse *urlResponse, NSError *error) { watchersLabel.text = [NSString stringWithFormat:@"SVHTTPRequest has %@ watchers", [response valueForKey:@"watchers"]]; }];
If most of your requests are made to the same API endpoint, you should instead use
SVHTTPClientso you can set parameters (
basePath,
cachePolicy,
sendParametersAsJSON,
"userAgent) that will be used for each request:
[[SVHTTPClient sharedClient] setBasePath:@"http://api.twitter.com/1/"];[[SVHTTPClient sharedClient] GET:@"users/show.json" parameters:[NSDictionary dictionaryWithObject:@"samvermette" forKey:@"screen_name"] completion:^(id response, NSHTTPURLResponse *urlResponse, NSError *error) { followersLabel.text = [NSString stringWithFormat:@"@samvermette has %@ followers", [response valueForKey:@"followers_count"]]; }];
You can have mutiple SVHTTPClient instances using the
sharedClientWithIdentifier:method.
If you would like to set those properties on individual requests, you'll need to alloc/init the request, set the attributes, and then call
start:
SVHTTPRequest *request = [[SVHTTPRequest alloc] initWithAddress:@"http://github.com/api/v2/json/repos/show/samvermette/SVHTTPRequest" method:SVHTTPRequestMethodGET parameters:nil completion:^(id response, NSHTTPURLResponse *urlResponse, NSError *error) { watchersLabel.text = [NSString stringWithFormat:@"SVHTTPRequest has %@ watchers", [[response valueForKey:@"repository"] valueForKey:@"watchers"]]; }]; request.cachePolicy = NSURLRequestReloadIgnoringLocalCacheData; [request start];
You can tell SVHTTPRequest to save a GET response directly to disk and track the progress along the way:
[SVHTTPRequest GET:@"http://example.com/db.sqlite.zip" parameters:nil saveToPath:[[NSHomeDirectory() stringByAppendingPathComponent:@"Documents"] stringByAppendingPathComponent:@"store.zip"] progress:^(float progress) { progressLabel.text = [NSString stringWithFormat:@"Downloading (%.0f%%)", progress*100]; } completion:^(id response, NSHTTPURLResponse *urlResponse, NSError *error) { progressLabel.text = @"Download complete"; // process file }];
Make sure you cancel requests for which the user isn't waiting on anymore:
SVHTTPRequest *request = [SVHTTPRequest GET:@"http://api.twitter.com/1/users/show.json" parameters:[NSDictionary dictionaryWithObject:@"samvermette" forKey:@"screen_name"] completion:^(id response, NSHTTPURLResponse *urlResponse, NSError *error) { NSLog(@"%@", response); }];[request cancel];
If you're using SVHTTPClient, you can do that by calling
cancelRequestsWithPath:or
cancelAllRequests.
By default, SVHTTPRequest will log messages to the console every time a request is made. You can disable this by adding the compiler flag
-DSVHTTPREQUEST_DISABLE_LOGGINGto SVHTTPRequest.m in Target Settings > Build Phases.
All SVHTTPRequest requests are made asynchronously using NSURLConnection's built-in asynchronous methods. The completion block, however, is executed on the main thread. You should dispatch it to a separate thread/queue if it's resource intensive enough that it hogs the main thread. This can be done easily using Grand Central Dispatch:
completion:^(id response, NSHTTPURLResponse *urlResponse, NSError *error) { dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{ // cpu-intensive code }); }];
SVHTTPRequest is brought to you by Sam Vermette and contributors to the project. If you have feature suggestions or bug reports, feel free to help out by sending pull requests or by creating new issues. If you're using SVHTTPRequest in your project, attribution would be nice.