Overcoat is an AFNetworking extension that makes it super simple for developers to use Mantle model objects with a REST client.
You can learn more about Mantle here.
In Overcoat, server API requests are defined by instances of the OVCQuery class. Using OVCQuery you can specify an HTTP method, a path that identifies the resource, a set of parameters, and a model class.
Servers typically respond to client API request with a dictionary or an array of dictionaries. Overcoat will transparently map those into model objects in a background queue.
For example, using this model of a GitHub issue, here is how we could use the GitHub API to list all the closed issues.
OVCClient *gitHubClient = [[OVCClient alloc] initWithBaseURL:[NSURL URLWithString:@"https://api.github.com"]];
[gitHubClient setAuthorizationHeaderWithUsername:@"johndoe" password:@"secret"];
OVCQuery *closedIssues = [OVCQuery queryWithMethod:OVCQueryMethodGet path:@"/user/issues" parameters:@{
@"state" : @"closed"
} modelClass:[GHIssue class]];
[gitHubClient executeQuery:closedIssues completionBlock:^(OVCRequestOperation *operation, NSArray *issues, NSError *error) {
if (!error) {
for (GHIssue *issue in issues) {
NSLog(@"issue: %@ title: %@", issue.number, issue.title);
}
}
}];Overcoat features a special client class which can authenticate API requests using an ACAccount object on supported social networking services (currently Twitter, Facebook, and Sina Weibo).
Here is how we could lookup for Twitter users.
@interface TwitterUser : MTLModel
@property (copy, nonatomic) NSString *identifier;
@property (copy, nonatomic) NSString *name;
@property (copy, nonatomic) NSString *screenName;
@property (copy, nonatomic) NSURL *profileImageURL;
@end@implementation TwitterUser
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"identifier": @"id_str",
@"screenName": @"screen_name",
@"profileImageURL": @"profile_image_url"
};
}
+ (NSValueTransformer *)profileImageURLJSONTransformer {
return [NSValueTransformer valueTransformerForName:MTLURLValueTransformerName];
}
@endOVCSocialClient *twitterClient = [[OVCSocialClient alloc] initWithBaseURL:[NSURL URLWithString:@"https://api.twitter.com/1.1"]];
twitterClient.account = myAccount;
OVCQuery *lookupUsers = [OVCQuery queryWithMethod:OVCQueryMethodGet path:@"/users/lookup.json" parameters:@{
@"screen_name" : @"twitterapi,twitter"
} modelClass:[TwitterUser class]];
[twitterClient executeQuery:lookupUsers completionBlock:^(OVCRequestOperation *operation, NSArray *users, NSError *error) {
if (!error) {
for (TwitterUser *user in users) {
NSLog(@"name: %@ screenName: %@", user.name, user.screenName);
}
}
}];Guillermo Gonzalez
@gonzalezreal
Overcoat is available under the MIT license. See LICENSE.md.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent