[swift] Swift Moya에서 REST API 테스트하기

28 Nov 2023

swift

Swift Moya는 Swift로 작성된 네트워킹 라이브러리로, RESTful API 테스트 및 호출을 쉽게 할 수 있습니다. Moya는 간단하고 강력한 API 호출 인터페이스를 제공하여 개발자가 네트워킹 코드를 작성하는 시간과 노력을 줄여줍니다.

이 튜토리얼에서는 Swift Moya를 사용하여 REST API를 테스트하는 방법에 대해 알아보겠습니다.

1. Moya 설치하기

먼저, 프로젝트에 Moya를 설치해야 합니다. Cocoapods를 사용하여 프로젝트에 Moya를 추가할 수 있습니다. Podfile에 다음과 같이 작성하고, pod install 명령어를 실행하세요.

target 'YourProjectName' do
  use_frameworks!
  
  pod 'Moya'
end

2. API 모델 작성하기

API 모델은 Moya를 사용하여 API 호출을 추상화한 것입니다. 먼저, API 모델을 생성하기 위해 TargetType 프로토콜을 준수하는 Enum을 작성해야 합니다. 다음은 간단한 예시입니다.

import Moya

enum API {
  case getUser(id: Int)
  case updateUser(id: Int, name: String)
}

extension API: TargetType {
  var baseURL: URL {
    return URL(string: "https://api.example.com")!
  }
  
  var path: String {
    switch self {
    case .getUser(let id):
      return "/users/\(id)"
    case .updateUser(let id, _):
      return "/users/\(id)"
    }
  }
  
  var method: Moya.Method {
    switch self {
    case .getUser:
      return .get
    case .updateUser:
      return .put
    }
  }
  
  var task: Task {
    switch self {
    case .getUser, .updateUser:
      return .requestPlain
    }
  }
  
  var headers: [String : String]? {
    return ["Content-type": "application/json"]
  }
  
  var sampleData: Data {
    return Data()
  }
}

이 예제에서는 getUser 및 updateUser API 호출을 정의했습니다. 각 API 요청에 대한 기본 URL, 경로, HTTP 메서드, 요청 파라미터, 헤더 등을 설정할 수 있습니다.

3. API 호출하기

이제 API 모델을 사용하여 실제 API 호출을 수행할 수 있습니다. 먼저, Moya Provider를 생성하고 API 요청을 보내는 방법을 알아보겠습니다. 다음은 예시 코드입니다.

import Moya

let provider = MoyaProvider<API>()

provider.request(.getUser(id: 1)) { result in
  switch result {
  case .success(let response):
    // API 호출 성공
    let json = try? JSONSerialization.jsonObject(with: response.data, options: [])
    print(json)
  case .failure(let error):
    // API 호출 실패
    print(error.localizedDescription)
  }
}

위 코드에서는 MoyaProvider를 생성하여 API를 호출합니다. .getUser(id: 1)는 getUser API를 호출하고, id 파라미터에 1을 전달하는 것을 의미합니다. 성공적으로 API 호출이 완료되면, 서버 응답 데이터를 JSON으로 변환하여 출력합니다.

이와 같은 방식으로 Moya를 사용하여 REST API를 테스트하고 호출할 수 있습니다. Moya를 사용하면 네트워킹 코드를 간결하게 작성하고, API 호출을 추상화하여 관리하기 쉬운 코드를 작성할 수 있습니다.

더 자세한 내용은 Moya GitHub 페이지를 참조하세요.