ModelMapperUsage.md

How to use APIKit + ModelMapper

Example using APIKitExt to combine APIKit and ModelMapper. Note that a complete example is available at Model Mapper Sample folder.

Model (Model Mapper)

Our model file will follow normal ModelMapper's guide.

struct Repo {
    var id: Int
    var fullName: String
    var stargazersCount: Int
}

extension Repo: Mappable {
    init(map: Mapper) throws {
        try id = map.from("id")
        try fullName = map.from("full_name")
        try stargazersCount = map.from("stargazers_count")
    }
}

Defining request type (APIKit + APIKitExt)

With APIKit used along with APIKitExt, we can parse Json result and immediately return Response type 🎉

struct RepoRequest: Request {
    typealias Response = [Repo]
    // ...
}

extension RepoRequest {
    func response(from object: Any, urlResponse: HTTPURLResponse) -> [Repo] {
        guard
            let tree = object as? [String: Any],
            let items = tree["items"],
            let repos = try? Repo.mapArray(items) // <- notice mapArray method here !
            else {
                return []
        }
        return repos
    }
}

Supported method

Here is list of supported methods

• mapObject : map a json object to a model object.
• mapArray : map a json object to a list of model objects.