[iOS/API] Algolia API를 이용해서 C.R.U.D 구현해보기

안녕하세요 Foma 입니다!

 

오늘은 Algoria라는 API에 대해서 알아보고 간단하게 사용하는 법에 대해서 알아보도록 하겠습니다.

 

바로 시작할게요~

---

알고리아란?😀

 

알고리아는 SaaS(Search as a Service) 플랫폼으로 즉, 검색 서비스 플랫폼입니다.

 

백엔드,프론트엔드,API 클라이언트 등 다양한 환경으로 API가 제공됩니다.

 

검색 서비스뿐만 아니라 AI,Analytics 등 다양한 기능을 제공합니다.

 

 

가격은 1000번 검색에 1달러입니다.

 

(검색 1번에 1원이니... 좀 비싼거 같네요...)

 

---

알고리아를 사용하면 어떤 것이 좋을까요?🤔

 

1. 자동완성 검색기능

 

알고리아는 검색 텍스트에 따라서 관련있는 텍스트를 포함하거나 관련있는 데이터들을 

 

빠르게 제공하여 사용자에게 좋은 경험을 제공합니다.

 

 

2. 대쉬보드

 

알고리아는 아래와 같이 데이터의 정보가 어떤 것이 있는지 보기 쉽게 제공하며

 

애널리틱스도 함께 제공하여 유저와 검색을 얼만큼 하였는지 등의 정보를 제공합니다.

 

---

그래서 어떻게 사용하는데? 🤨

 

 

먼저 아래 알고리아 사이트로 가서 회원가입을 해줍니다.

 

Site Search & Discovery powered by AI

로그인을 하고 홈페이지의 오른쪽 상단에 DASHBOARD를 클릭해줍니다.

왼쪽탭에 API keys를 탭해줍니다.

 

여기서 Application ID와 Admin API Key가 필요하니 잘 저장해주세요!

 

---

Xcode

 

이제 Xcode로 이동해서 코코아팟에 알고리아를 설치해줍니다.

pod 'AlgoliaSearchClient', '~> 8.0'

 

User

 

유저 정보를 만들어줍니다.

import Foundation

struct User:Codable {
    let name:String
    let age:Int
    let description:String
    
    init(name:String,age:Int,desc:String) {
        self.name = name
        self.age = age
        self.description = desc
    }
}

---

Storyboard

 

Searchbar와 테이블뷰를 세팅해줍니다.

 

---

ViewController

 

AlgoliaSearchClient를 import 해주세요!

 

import AlgoliaSearchClient

 

스토리보드에서 서치바와 테이블뷰를 연결시켜줍니다.

 

   @IBOutlet weak var searchBar: UISearchBar!
   @IBOutlet weak var table: UITableView!

 

위에서 저장한 애플리케이션 아이디와 어드민 키를 적어서 client를 세팅해주고

 

index를 users로 설정해줍니다.( 여기서는 user정보를 담아 users라고 했지만 원하는 이름으로 하셔도 됩니다!)

 

그리곤 user들을 담을 users배열과 검색한 유저들이 담길 filterUsers를 만들어줍니다.

    let client = SearchClient(appID: "Application ID", apiKey: "Admin API Key")
    lazy var index = client.index(withName: "users")
    var users:[User] = []
    var filterUsers:[User] = []

서치바 딜리게이트와 테이블뷰의 데이터소스를 설정해줍니다.

 private func configure() {
        searchBar.delegate = self
        table.dataSource = self
    }

 

테이블뷰 데이터소스와 서치바딜리게이트 메소드를 세팅해줍니다.

 

extension ViewController:UITableViewDataSource {
    func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return filterUsers.count
    }
    
    func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
        let cell = table.dequeueReusableCell(withIdentifier: "Cell", for: indexPath)
        return cell
    }
}

extension ViewController:UISearchBarDelegate {
    func searchBarSearchButtonClicked(_ searchBar: UISearchBar) {
    
    }
}

 

유저들을 세팅해줍니다.

 

   private func setUsers() {
        let user1 = User(name: "Foma", age: 26, desc: "안녕하세요 저는 포마입니다. 만나서 반가워요~")
        let user2 = User(name: "gran", age: 27, desc: "안녕하세요 저는 그랜입니다. 처음뵙겝습니다.")
        let user3 = User(name: "Fomagran", age: 28, desc: "포마그랜입니다!!")
        
        users = [user1,user2,user3]
    }

 

---

데이터 저장하기

 

위에서 만든 users를 algolia에 저장해줍니다.

private func saveToAlgolia(){
        index.saveObjects(users, autoGeneratingObjectID: true) { result in
            if case .success(let response) = result {
                print("Response: \(response)")
            }
        }
    }

실행시킨 뒤 알고리아 대쉬보드로 이동해 indices를 보면

 

index로 만들어준 users가 있고

그 안에 데이터들을 잘 저장된걸 볼 수 있습니다.

 

 

데이터 정렬하기

 

Algolia에 있는 데이터들을 age기준 오름차순으로 정렬해보겠습니다.

 private func sortAlgolia() {
        let settings = Settings()
            .set(\.customRanking, to: [.asc("age")])
        index.setSettings(settings) { result in
            switch result {
            case .failure(let error):
                print("Error when applying settings: \(error)")
            case .success:
                print("Success")
            }
        }
    }

 

Algolia 대쉬보드로 가서 확인해보면 나이가 적은순으로 정렬된 것을 볼 수 있습니다.

 

 

 

 

데이터 수정하기

 

원하는 오브젝트ID를 넣고 수정할 attribute 이름과 값을 넣은 뒤 수정해줍니다.

  private func updateObject() {
        let updates: [(ObjectID, PartialUpdate)] = [
          ("1111212002", .update(attribute: "age", value: 30))
        ]

        index.partialUpdateObjects(updates: updates) { result in
          if case .success(let response) = result {
            print("Response: \(response)")
          }
        }
    }

 

Algolia 대쉬보드를 확인해보면 해당 objectID를 가진 객체의 age가 잘 변경된 것을 볼 수 있습니다.

 

 

 

데이터 검색하기

 

아래와 같이 서치바의 입력한 글자가 포함된 데이터를 가져와 filterUsers의 데이터를 변경하고

 

테이블뷰를 reload시켜주는 메소드를 만들어줍니다.

 

  private func searchAlgolia(searchText:String) {
        
        index.search(query: "\(searchText)") { result in
            switch result {
            case .failure(let error):
                print("Error: \(error)")
            case .success(let response):
                print("Response: \(response.hits)")
                do {
                    self.filterUsers = try response.extractHits()
                    DispatchQueue.main.async {
                        self.table.reloadData()
                    }
                } catch let error {
                    print("Contact parsing error: \(error)")
                }
            }
        }
    }

 

UISearchBarDelegate의 searchBarSearchButtonClicked 메소드에 searchAlgolia 메소드를 넣어줍니다.

 func searchBarSearchButtonClicked(_ searchBar: UISearchBar) {
        searchAlgolia(searchText: searchBar.text ?? "")
    }

 

이렇게 세팅한 뒤 검색을 해보면 검색어가 포함된 데이터가 필터링 되는것을 볼 수 있습니다!

 

 

 

데이터 삭제하기

 

삭제하고싶은 오브젝트 아이디를 넣어주고 삭제해줍니다.

 private func deleteObject() {
        index.deleteObject(withID: "1111212002") { result in
          if case .success(let response) = result {
            print("Response: \(response)")
          }
        }
    }

Algolia 대쉬보드를 보면 해당 오브젝트가 삭제된걸 볼 수 있습니다 !

 

---

오늘은 이렇게 Algolia가 무엇이고 Algolia에서 데이터를 저장하고 수정하고 검색하고 삭제하는 법에 대해서 알아보았습니다.

 

혹시라도 틀린 점이 있거나 궁금하신 점이 있다면 댓글로 알려주세요!

 

---

Reference

 

Algolia Docs