[Kotlin, Ktor] ktor로 http api 만들기(2)

 

지난 포스팅

https://rkdrkd-history.tistory.com/52

[Kotlin, Ktor] ktor 프로젝트 시작하기(1)

 

지난 포스팅에서 ktor project를 생성하는 방법을 알아보았다.

이번 포스팅에서는 ktor로 HTTP api를 만들어 보겠다.

---

ktor 서버 실행하기

일단 ktor서버를 실행시켜 보자.

ktor project를 만들면 기본으로 나오는 샘플 코드가 있다(처음에 만들 때 설정으로 샘플 코드 생성을 안 하게 할 수도 있다).

 

Routing.kt

package com.example.plugins

import io.ktor.server.routing.*
import io.ktor.server.response.*
import io.ktor.server.application.*

fun Application.configureRouting() {
    routing {
        get("/") {
            call.respondText("Hello World!")
        }
    }
}

이 코드를 가지고 서버를 실행해 보겠다.

 

Application.kt로 이동한 후main 함수에서 실행해 보도록 하자.

 

실행 결과는 다음과 같다.

logcat

web

이렇게 나오면 성공적으로 서버 실행을 마친 것이다.

 

간단 api 만들기

공식 문서에 나와 있는 코드를 이용해 간단한 api를 생성해 보도록 하겠다.

 

Customers.kt

package com.example.models

import kotlinx.serialization.Serializable

@Serializable
data class Customers(
    val id: String,
    val firstName: String,
    val lastName: String,
    val email: String
)

val customerStorage = mutableListOf<Customers>()

ktor에서 data 클래스를 만들어 준다.

@Serializable 어노테이션이 ktor 서버에 응답 json을 생성해 준다.

 

1. GET

get {
    if (customerStorage.isNotEmpty()) call.respond(customerStorage)
    else call.respondText("No Customer Found.", status = HttpStatusCode.OK)
}
get("{id}") {
    val id = call.parameters["id"] ?: return@get call.respondText(
        text = "Missing Id",
        status = HttpStatusCode.BadRequest
    )
    val customer = customerStorage.find { it.id == id } ?: return@get call.respondText(
        text = "No Customer with id $id",
        status = HttpStatusCode.NotFound
    )
    call.respond(customer)
}

첫 번째 get은 customer들의 정보를 나열하는 api이고

두 번째 get은 customerStorage의 id를 기준으로 한 명의 customer만 조회하는 부분이다.

• id를 먼저 불러온다.
  id가 null이면 missing id text를 출력하도록 했다.
• customer 정보를 불러온다.
  find를 이용해 같은 id의 정보만 뽑아온다.
  없으면 not found 에러를 발생시킨다.

 

2. POST

post {
    val customer = call.receive<Customers>()
    customerStorage.add(customer)
    call.respondText(
        text = "Customer stored correctly",
        status = HttpStatusCode.Created
    )
}

post를 이용해 customer 정보를 저장한다.

 

3. DELETE

delete("{id}") {
    val id = call.parameters["id"] ?: return@delete call.respond(HttpStatusCode.BadRequest)
    if (customerStorage.removeIf { it.id == id })
        call.respondText(
            text = "Customer remove correctly",
            status = HttpStatusCode.Accepted
        )
    else call.respondText(text = "Not found.", status = HttpStatusCode.NotFound)
}

delete로 특정 id의 customer를 삭제한다.

 

4. Response를 JSON으로 설정

install(ContentNegotiation) {
    json(Json {
        prettyPrint = true
        isLenient = true
    })
}

이 코드는 ktor 서버의 response값을 json으로 설정해 주는 부분이다.

이 코드를 작성하면 추후에 android studio에서 retrofit으로 통신을 할 때 415 에러(Unsupported Media Type)가 발생할 수 있으니 작성하도록 하자(실제로 겪었었다...ㅠ).

 

ktor에서 post 부분의 receive <T> 부분은 T객체를 request body로 받는 것을 뜻하고

respond는 특정 형의 객체를 api response로 반환하는 것을 뜻한다.

• call.receive <Customers>: Customers 객체를 request body로 받기
• call.respond(Customers(... )): Customers 객체를 api response로 지정

 

전체 코드

CustomerRoutes.kt

package com.example.routes

import com.example.models.Customers
import com.example.models.ResponseData
import com.example.models.customerStorage
import io.ktor.http.*
import io.ktor.serialization.kotlinx.json.*
import io.ktor.server.application.*
import io.ktor.server.plugins.contentnegotiation.*
import io.ktor.server.request.*
import io.ktor.server.response.*
import io.ktor.server.routing.*
import kotlinx.serialization.json.Json

fun Route.customerRouting() {
    route("/customer") {
        install(ContentNegotiation) {
            json(Json {
                prettyPrint = true
                isLenient = true
            })
        }
        get {
            if (customerStorage.isNotEmpty()) call.respond(customerStorage)
            else call.respondText("No Customer Found.", status = HttpStatusCode.OK)
        }
        get("{id}") {
            val id = call.parameters["id"] ?: return@get call.respondText(
                text = "Missing Id",
                status = HttpStatusCode.BadRequest
            )
            val customer = customerStorage.find { it.id == id } ?: return@get call.respondText(
                text = "No Customer with id $id",
                status = HttpStatusCode.NotFound
            )
            call.respond(customer)
        }
        post {
            val customer = call.receive<Customers>()
            customerStorage.add(customer)

            call.respond(
                status = HttpStatusCode.Created,
                message = ResponseData("Customer stored correctly")
            )
        }
        delete("{id}") {
            val id = call.parameters["id"] ?: return@delete call.respond(HttpStatusCode.BadRequest)
            if (customerStorage.removeIf { it.id == id })
                call.respondText(
                    text = "Customer remove correctly",
                    status = HttpStatusCode.Accepted
                )
            else call.respondText(text = "Not found.", status = HttpStatusCode.NotFound)
        }
    }
}

일단 간단하게 get, post, delete 로직을 만들어 주었다.

 

파일 구조(ktor)

 

Android에서 Retrofit으로 서버 테스트하는 코드는 생략하겠다.

---

정리

ktor로 http api를 만들어봤는데 만들고 나서 android와 연동해 테스트할 때 response 타입을 맞추지 않아서 415 에러가 계속 발생했었는데 간단한 문제였는데 하루를 날렸었다...ㅠ

다음 포스팅에서는 ktor에서 database를 이용해 보도록 하겠다.