[swift] Swift Moya와 ObjectMapper을 사용하여 API 요청 후 데이터 매핑하는 방법과 예제 코드 설명

15 Nov 2023

swift

소개

Swift에서 API 요청을 하고 받은 데이터를 매핑하는 작업은 일반적이고 반복적인 작업입니다. 이 작업을 간편하게 처리하기 위해 Moya와 ObjectMapper을 사용할 수 있습니다. Moya는 Swift용 네트워킹 추상화 라이브러리이며, ObjectMapper는 Swift에서 JSON 데이터를 객체로 매핑하기 위한 라이브러리입니다. 이 두 라이브러리를 함께 사용하면 API 요청과 데이터 매핑을 간단하게 처리할 수 있습니다.

Moya와 ObjectMapper 설치

Moya와 ObjectMapper을 사용하기 위해서는 먼저 CocoaPods 또는 Swift Package Manager를 통해 라이브러리를 설치해야 합니다.

CocoaPods를 사용하는 경우, Podfile에 다음과 같이 추가합니다:

pod 'Moya'
pod 'ObjectMapper'

Swift Package Manager를 사용하는 경우, 프로젝트의 Package.swift 파일에 다음과 같이 추가합니다:

dependencies: [
    .package(url: "https://github.com/Moya/Moya.git", .upToNextMajor(from: "14.0.0")),
    .package(url: "https://github.com/tristanhimmelman/ObjectMapper.git", .upToNextMajor(from: "4.2.0")),
],
targets: [
    .target(name: "YourTarget", dependencies: ["Moya", "ObjectMapper"])
]

이제 라이브러리를 설치하고 프로젝트를 빌드할 준비가 되었습니다.

API 요청과 데이터 매핑 예제

다음은 Moya와 ObjectMapper을 사용하여 API 요청 후 데이터를 매핑하는 예제 코드입니다.

import Moya
import ObjectMapper

// API 요청에 대한 Endpoint 정의
enum MyAPI {
    case getUser(id: Int)
}

extension MyAPI: TargetType {
    var baseURL: URL {
        return URL(string: "https://api.example.com")!
    }
    
    var path: String {
        switch self {
        case .getUser(let id):
            return "/users/\(id)"
        }
    }
    
    var method: Moya.Method {
        return .get
    }
    
    var sampleData: Data {
        return Data()
    }
    
    var task: Task {
        return .requestPlain
    }
    
    var headers: [String: String]? {
        return nil
    }
}

// MoyaProvider 생성
let provider = MoyaProvider<MyAPI>()

// API 요청 후 데이터 매핑
provider.request(.getUser(id: 1)) { result in
    switch result {
    case let .success(response):
        do {
            let json = try response.mapJSON()
            if let user = Mapper<User>().map(JSONObject: json) {
                // 매핑된 데이터 사용
                print(user.name)
                print(user.email)
            }
        } catch {
            // 매핑 실패 시 에러 처리
            print(error)
        }
        
    case let .failure(error):
        // 요청 실패 시 에러 처리
        print(error)
    }
}

위의 예제 코드에서는 MyAPI 열거형을 통해 API 요청에 대한 Endpoint를 정의하고, MoyaProvider를 생성하여 API를 요청합니다. 요청 후에는 응답 데이터를 ObjectMapper를 사용하여 User 객체로 매핑합니다.

결론

Swift Moya와 ObjectMapper을 함께 사용하여 API 요청과 데이터 매핑을 간단하게 처리할 수 있습니다. Moya를 사용하면 네트워킹 관련 코드를 추상화하여 간결하게 작성할 수 있으며, ObjectMapper를 사용하면 JSON 데이터를 객체로 매핑하는 작업을 쉽게 처리할 수 있습니다. 이러한 라이브러리의 조합은 Swift 프로젝트에서 API 통신을 효율적으로 처리하는 데 도움을 줄 것입니다.

참고 문서: