[swift] Moya와 ObjectMapper를 사용하여 API 호출 및 데이터 매핑하는 프로세스 이해하기

15 Nov 2023

swift

Moya와 ObjectMapper는 Swift로 API 호출과 데이터 매핑을 간단하게 처리할 수 있는 라이브러리들입니다. 이 글에서는 Moya와 ObjectMapper를 사용하는 방법에 대해 알아보겠습니다.

Moya란?

Moya는 Alamofire를 기반으로 만들어진 네트워킹 라이브러리입니다. Moya는 API를 클라이언트-서버 형태로 정의하여 사용할 수 있도록 도와줍니다. API 엔드포인트와 요청 메서드(GET, POST 등), 파라미터 등을 선언하고 사용하면 Moya가 해당 내용을 기반으로 실제 네트워크 요청을 만들어줍니다.

ObjectMapper란?

ObjectMapper는 Swift에서 JSON 데이터와 모델 객체 간의 매핑을 담당하는 라이브러리입니다. ObjectMapper를 사용하면 JSON 데이터를 받아서 모델 객체로 변환하거나, 모델 객체를 JSON 데이터로 변환할 수 있습니다.

Moya와 ObjectMapper를 함께 사용하기

이제 Moya와 ObjectMapper를 함께 사용하여 API 호출 및 데이터 매핑하는 프로세스에 대해 알아보겠습니다.

먼저, API 엔드포인트와 요청 메서드를 정의하고 Moya의 Target 프로토콜을 준수하는 Enum을 만듭니다. 예를 들어, User 모델을 가져오는 API를 호출하는 경우 다음과 같이 정의할 수 있습니다:

import Moya

enum UserAPI {
    case getUser(id: Int)
}

extension UserAPI: TargetType {
    // API 엔드포인트를 설정합니다.
    var baseURL: URL {
        return URL(string: "https://api.example.com")!
    }

    // 각 요청 메서드별로 경로와 파라미터를 설정합니다.
    var path: String {
        switch self {
        case .getUser(let id):
            return "/user/\(id)"
        }
    }

    var method: Moya.Method {
        switch self {
        case .getUser:
            return .get
        }
    }

    var task: Task {
        return .requestPlain
    }

    var headers: [String: String]? {
        return nil
    }
}

ObjectMapper를 사용하여 API 응답 데이터를 모델 객체로 매핑합니다. 이때, Moya의 Response 객체를 ObjectMapper로 변환하여 사용합니다. 예를 들어, 다음과 같이 사용할 수 있습니다:

import Moya
import ObjectMapper

MoyaProvider<UserAPI>.default.request(.getUser(id: 1)) { result in
    switch result {
    case .success(let response):
        do {
            // 응답 데이터를 모델 객체로 매핑합니다.
            let user = try response.mapObject(User.self)
            print(user.name)
        } catch {
            print(error)
        }
    case .failure(let error):
        print(error)
    }
}

이렇게 Moya와 ObjectMapper를 함께 사용하여 API 호출과 데이터 매핑을 처리할 수 있습니다.

결론

Moya와 ObjectMapper는 Swift로 API 호출과 데이터 매핑을 간단하게 처리할 수 있는 라이브러리들입니다. Moya를 사용하여 API 요청을 정의하고, ObjectMapper를 사용하여 JSON 데이터를 모델 객체로 매핑할 수 있습니다. 이를 통해 개발자는 효율적이고 간결한 방식으로 API 호출과 데이터 매핑을 처리할 수 있습니다.

참고 자료

Moya 공식 문서: https://github.com/Moya/Moya
ObjectMapper 공식 문서: https://github.com/tristanhimmelman/ObjectMapper