Github url

jsonmodel

by jsonmodel

jsonmodel /jsonmodel

Magical Data Modeling Framework for JSON - allows rapid creation of smart data models. You can use i...

6.8K Stars 1.1K Forks Last release: almost 4 years ago (1.7.0) MIT License 732 Commits 29 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

JSONModel - Magical Data Modeling Framework for JSON

JSONModel allows rapid creation of smart data models. You can use it in your iOS, macOS, watchOS and tvOS apps. Automatic introspection of your model classes and JSON input drastically reduces the amount of code you have to write.

See CHANGELOG.md for details on changes.

Installation

CocoaPods

pod 'JSONModel'

Carthage

github "jsonmodel/jsonmodel"

Manual

  1. download the JSONModel repository
  2. copy the JSONModel sub-folder into your Xcode project
  3. link your app to SystemConfiguration.framework

Basic Usage

Consider you have JSON like this:

{ "id": 10, "country": "Germany", "dialCode": 49, "isInEurope": true }
  • create a JSONModel subclass for your data model
  • declare properties in your header file with the name of the JSON keys:
@interface CountryModel : JSONModel @property (nonatomic) NSInteger id; @property (nonatomic) NSString \*country; @property (nonatomic) NSString \*dialCode; @property (nonatomic) BOOL isInEurope; @end

There's no need to do anything in the implementation (

.m

) file.

  • initialize your model with data:
NSError \*error; CountryModel \*country = [[CountryModel alloc] initWithString:myJson error:&error];

If the validation of the JSON passes. you have all the corresponding properties in your model populated from the JSON. JSONModel will also try to convert as much data to the types you expect. In the example above it will:

  • convert
    id
    from string (in the JSON) to an
    int
    for your class
  • copy the
    country
    value
  • convert
    dialCode
    from a number (in the JSON) to an
    NSString
    value
  • copy the
    isInEurope
    value

All you have to do is define the properties and their expected types.

Examples

Automatic name based mapping

{ "id": 123, "name": "Product name", "price": 12.95 }
@interface ProductModel : JSONModel @property (nonatomic) NSInteger id; @property (nonatomic) NSString \*name; @property (nonatomic) float price; @end

Model cascading (models including other models)

{ "orderId": 104, "totalPrice": 13.45, "product": { "id": 123, "name": "Product name", "price": 12.95 } }
@interface ProductModel : JSONModel @property (nonatomic) NSInteger id; @property (nonatomic) NSString \*name; @property (nonatomic) float price; @end @interface OrderModel : JSONModel @property (nonatomic) NSInteger orderId; @property (nonatomic) float totalPrice; @property (nonatomic) ProductModel \*product; @end

Model collections

{ "orderId": 104, "totalPrice": 103.45, "products": [{ "id": 123, "name": "Product #1", "price": 12.95 }, { "id": 137, "name": "Product #2", "price": 82.95 }] }
@protocol ProductModel; @interface ProductModel : JSONModel @property (nonatomic) NSInteger id; @property (nonatomic) NSString \*name; @property (nonatomic) float price; @end @interface OrderModel : JSONModel @property (nonatomic) NSInteger orderId; @property (nonatomic) float totalPrice; @property (nonatomic) NSArray <productmodel> *products;
@end
</productmodel>

Note: the angle brackets after

NSArray

contain a protocol. This is not the same as the Objective-C generics system. They are not mutually exclusive, but for JSONModel to work, the protocol must be in place.

Also property can have generics info for compiler

objc @interface OrderModel : JSONModel @property (nonatomic) NSInteger orderId; @property (nonatomic) float totalPrice; @property (nonatomic) NSArray<productmodel> <productmodel> *products;
@end
</productmodel></productmodel>

Nested key mapping

{ "orderId": 104, "orderDetails": { "name": "Product #1", "price": { "usd": 12.95 } } }
@interface OrderModel : JSONModel @property (nonatomic) NSInteger id; @property (nonatomic) NSString \*productName; @property (nonatomic) float price; @end @implementation OrderModel + (JSONKeyMapper \*)keyMapper { return [[JSONKeyMapper alloc] initWithModelToJSONDictionary:@{ @"id": @"orderId", @"productName": @"orderDetails.name", @"price": @"orderDetails.price.usd" }]; } @end

Map automatically to snake_case

{ "order\_id": 104, "order\_product": "Product #1", "order\_price": 12.95 }
@interface OrderModel : JSONModel @property (nonatomic) NSInteger orderId; @property (nonatomic) NSString \*orderProduct; @property (nonatomic) float orderPrice; @end @implementation OrderModel + (JSONKeyMapper \*)keyMapper { return [JSONKeyMapper mapperForSnakeCase]; } @end

Optional properties (i.e. can be missing or null)

{ "id": 123, "name": null, "price": 12.95 }
@interface ProductModel : JSONModel @property (nonatomic) NSInteger id; @property (nonatomic) NSString <optional> *name;
@property (nonatomic) float price;
@property (nonatomic) NSNumber <optional> *uuid;
@end
</optional></optional>

Ignored properties (i.e. JSONModel completely ignores them)

{ "id": 123, "name": null }
@interface ProductModel : JSONModel @property (nonatomic) NSInteger id; @property (nonatomic) NSString <ignore> *customProperty;
@end
</ignore>

Making scalar types optional

{ "id": null }
@interface ProductModel : JSONModel @property (nonatomic) NSInteger id; @end @implementation ProductModel + (BOOL)propertyIsOptional:(NSString \*)propertyName { if ([propertyName isEqualToString:@"id"]) return YES; return NO; } @end

Export model to

NSDictionary

or JSON

ProductModel \*pm = [ProductModel new]; pm.name = @"Some Name"; // convert to dictionary NSDictionary \*dict = [pm toDictionary]; // convert to json NSString \*string = [pm toJSONString];

Custom data transformers

@interface JSONValueTransformer (CustomTransformer) @end @implementation JSONValueTransformer (CustomTransformer) - (NSDate \*)NSDateFromNSString:(NSString \*)string { NSDateFormatter \*formatter = [NSDateFormatter new]; formatter.dateFormat = APIDateFormat; return [formatter dateFromString:string]; } - (NSString \*)JSONObjectFromNSDate:(NSDate \*)date { NSDateFormatter \*formatter = [NSDateFormatter new]; formatter.dateFormat = APIDateFormat; return [formatter stringFromDate:date]; } @end

Custom getters/setters

@interface ProductModel : JSONModel @property (nonatomic) NSInteger id; @property (nonatomic) NSString \*name; @property (nonatomic) float price; @property (nonatomic) NSLocale \*locale; @end @implementation ProductModel - (void)setLocaleWithNSString:(NSString \*)string { self.locale = [NSLocale localeWithLocaleIdentifier:string]; } - (void)setLocaleWithNSDictionary:(NSDictionary \*)dictionary { self.locale = [NSLocale localeWithLocaleIdentifier:dictionary[@"identifier"]]; } - (NSString \*)JSONObjectForLocale { return self.locale.localeIdentifier; } @end

Custom JSON validation

@interface ProductModel : JSONModel @property (nonatomic) NSInteger id; @property (nonatomic) NSString \*name; @property (nonatomic) float price; @property (nonatomic) NSLocale \*locale; @property (nonatomic) NSNumber <ignore> *minNameLength;
@end

@implementation ProductModel

- (BOOL)validate:(NSError **)error
{
    if (![super validate:error])
        return NO;

    if (self.name.length &lt; self.minNameLength.integerValue)
    {
        *error = [NSError errorWithDomain:@"me.mycompany.com" code:1 userInfo:nil];
        return NO;
    }

    return YES;
}

@end
</ignore>

License

MIT licensed - see LICENSE file.

Contributing

We love pull requests! See CONTRIBUTING.md for full details.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.