[Kotlin][SpringBoot3] Kopring 서버 기본 실습 08 - 다양한 api 구현해보기 - get, post, put, delete method With path variable, request param, request body

 

1. 이전 포스팅

 

https://growingsaja.tistory.com/973

[Kotlin][SpringBoot3] Kopring 서버 실습 07 - 소스코드 중간점검 리펙토링 : Controller - Service - Repository - En

 

 

 

 

 

2. 목표

 

 a. 다양한 method 구현

    - GET

    - POST

    - PUT

    - DELETE

 

  b. 다양한 형태로 데이터 전달 기능 구현

    - Path Variable

    - Request Param

    - Request Body

 

 

 

 

3. User 관련 기능 목표에 맞게 예시 api 구현

 

// vim entities/User.kt

package com.example.practicekopring.entities

import org.springframework.data.annotation.Id
import org.springframework.data.mongodb.core.mapping.Document

@Document(collection = "users")
data class User(
    @Id
    val id: String? = null,
    var username: String? =null,
    var email: String? =null
)

// vim repositories/UserRepository.kt

package com.example.practicekopring.repositories

import com.example.practicekopring.entities.User
import org.springframework.data.mongodb.repository.MongoRepository

// UserRepository 인터페이스는 User 엔터티와 관련된 데이터베이스 작업을 위한 Repository입니다.
interface UserRepository : MongoRepository<User, String> {
    fun findByUsername(username: String): User?
    fun findByEmail(email: String): User?
    fun findByUsernameContaining(keyword: String): List<User>
    fun findByEmailContaining(keyword: String): List<User>
    fun findAllByOrderByUsernameAsc(): List<User>
}

// vim services/UserService.kt

package com.example.practicekopring.services

import com.example.practicekopring.entities.User
import com.example.practicekopring.repositories.UserRepository
import org.springframework.data.domain.Page
import org.springframework.data.domain.PageRequest
import org.springframework.data.domain.Pageable
import org.springframework.stereotype.Service

@Service
class UserService(private val userRepository: UserRepository) {

    // 1. 모든 사용자 조회
    fun getAllUsers(): List<User> {
        return userRepository.findAll()
    }

    fun createUser(username: String, email: String): User {
        val user = User(username = username, email = email)
        return userRepository.save(user)
    }

    fun getUserByUsername(username: String): User? {
        return userRepository.findByUsername(username)
    }

    // 3. 사용자 이메일로 조회
    fun getUserByEmail(email: String): User? {
        return userRepository.findByEmail(email)
    }

    // 5. 사용자 업데이트
    fun updateUser(id: String, username: String, email: String): User? {
        val existingUser = userRepository.findById(id)
        if (existingUser.isPresent) {
            val userToUpdate = existingUser.get()
            userToUpdate.username = username
            userToUpdate.email = email
            return userRepository.save(userToUpdate)
        }
        return null
    }

    // 5-1. 사용자 업데이트
    fun updateUserWithBody(user: User): User? {
        return userRepository.save(user)
    }

    // 6. 사용자 삭제
    fun deleteUser(id: String) {
        userRepository.deleteById(id)
    }

    // 7. 사용자 카운트 조회
    fun getUserCount(): Long {
        return userRepository.count()
    }

    // 8. 사용자 이름으로 부분 일치 검색
    fun searchUsersByUsername(keyword: String): List<User> {
        return userRepository.findByUsernameContaining(keyword)
    }

    // 9. 사용자 이메일로 부분 일치 검색
    fun searchUsersByEmail(keyword: String): List<User> {
        return userRepository.findByEmailContaining(keyword)
    }

    // 10. 사용자 정렬 조회 (예: 이름 오름차순)
    fun getUsersSortedByName(): List<User> {
        return userRepository.findAllByOrderByUsernameAsc()
    }

    // 11. 특정 페이지의 사용자 조회 (페이징)
    fun getUsersByPage(page: Int, size: Int): Page<User> {
        val pageable: Pageable = PageRequest.of(page, size)
        return userRepository.findAll(pageable)
    }
}

// vim controllers/UserController.kt

package com.example.practicekopring.controllers

import com.example.practicekopring.entities.User
import com.example.practicekopring.services.UserService
import org.springframework.data.domain.Page
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.PostMapping
import org.springframework.web.bind.annotation.PutMapping
import org.springframework.web.bind.annotation.DeleteMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RequestParam
import org.springframework.web.bind.annotation.RequestBody
import org.springframework.web.bind.annotation.RestController
import org.springframework.web.bind.annotation.PathVariable

@RestController
@RequestMapping("/api/v1/users")
class UserController(private val userService: UserService) {

    // 1. 모든 사용자 조회
    @GetMapping("/")
    fun getAllUsers(): List<User> {
        return userService.getAllUsers()
    }

    // 2. 사용자 생성
    @PostMapping("/create")
    fun createUser(
        @RequestParam username: String,
        @RequestParam email: String
    ): User {
        return userService.createUser(username, email)
    }

    // 3. 사용자 이름으로 조회
    @GetMapping("/by-username")
    fun getUserByUsername(
        @RequestParam username: String
    ): User? {
        return userService.getUserByUsername(username)
    }

    // 4. 사용자 이메일로 조회
    @GetMapping("/by-email")
    fun getUserByEmail(
        @RequestParam email: String
    ): User? {
        return userService.getUserByEmail(email)
    }

    // 5. 사용자 업데이트
    @PutMapping("/{id}/update")
    fun updateUser(
        @PathVariable id: String,
        @RequestParam email: String,
        @RequestParam username: String
    ): User? {
        return userService.updateUser(id, username, email)
    }

    // 5-1. 사용자 업데이트 body 버전
    @PostMapping("/update-with-body")
    fun updateUserWithBody(
        @RequestBody user: User
    ): User? {
        return userService.updateUserWithBody(user)
    }

    // 6. 사용자 삭제
    @DeleteMapping("/{id}/delete")
    fun deleteUser(
        @PathVariable id: String
    ) {
        userService.deleteUser(id)
    }

    // 7. 사용자 카운트 조회
    @GetMapping("/count")
    fun getUserCount(): Long {
        return userService.getUserCount()
    }

    // 8. 사용자 이름으로 부분 일치 검색
    @GetMapping("/search-by-username")
    fun searchUsersByUsername(
        @RequestParam keyword: String
    ): List<User> {
        return userService.searchUsersByUsername(keyword)
    }

    // 9. 사용자 이메일로 부분 일치 검색
    @GetMapping("/search-by-email")
    fun searchUsersByEmail(
        @RequestParam keyword: String
    ): List<User> {
        return userService.searchUsersByEmail(keyword)
    }

    // 10. 사용자 정렬 조회 (예: 이름 오름차순)
    @GetMapping("/sorted")
    fun getUsersSortedByName(): List<User> {
        return userService.getUsersSortedByName()
    }

    // 11. 특정 페이지의 사용자 조회 (페이징)
    @GetMapping("/paged")
    fun getUsersByPage(
        @RequestParam page: Int,
        @RequestParam size: Int
    ): Page<User> {
        return userService.getUsersByPage(page, size)
    }
}

 

 

 

 

 

4. 현재 User 데이터 현황

 

 

 

 

 

 

5. put method 

 

필자는 가장 상단에 있는, 아래 id를 가진 이용자를 대상으로 api 정상 여부를 확인해줍니다.

64f59183f3dc171b96a450a5

curl -X 'PUT' \
  'http://localhost:8080/api/v1/users/64f59183f3dc171b96a450a5/update?email=new01&username=new1%40test.co.kr' \
  -H 'accept: */*'

 

curl -X 'POST' \
  'http://localhost:8080/api/v1/users/update-with-body' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "64f59183f3dc171b96a450a5",
  "username": "new02",
  "email": "new2@gmail.com"
}'

 

curl -X 'POST' \
  'http://localhost:8080/api/v1/users/create?username=Saja&email=saja%40tecting.com' \
  -H 'accept: */*' \
  -d ''

 

curl -X 'GET' \
  'http://localhost:8080/api/v1/users/sorted' \
  -H 'accept: */*'

 

curl -X 'GET' \
  'http://localhost:8080/api/v1/users/search-by-username?keyword=test' \
  -H 'accept: */*'

 

curl -X 'GET' \
  'http://localhost:8080/api/v1/users/search-by-email?keyword=test' \
  -H 'accept: */*'

 

curl -X 'GET' \
  'http://localhost:8080/api/v1/users/paged?page=0&size=2' \
  -H 'accept: */*'

curl -X 'GET' \
  'http://localhost:8080/api/v1/users/paged?page=1&size=5' \
  -H 'accept: */*'

{
  "content": [
    {
      "id": "64f7fa9c99cebf22ed19943d",
      "username": "Saja",
      "email": "saja@tecting.com"
    }
  ],
  "pageable": {
    "sort": {
      "empty": true,
      "sorted": false,
      "unsorted": true
    },
    "offset": 5,
    "pageNumber": 1,
    "pageSize": 5,
    "paged": true,
    "unpaged": false
  },
  "last": true,
  "totalPages": 2,
  "totalElements": 6,
  "sort": {
    "empty": true,
    "sorted": false,
    "unsorted": true
  },
  "first": false,
  "number": 1,
  "size": 5,
  "numberOfElements": 1,
  "empty": false
}

 

curl -X 'GET' \
  'http://localhost:8080/api/v1/users/count' \
  -H 'accept: */*'

 

정확하게 username이 일치하는 값만 조회

curl -X 'GET' \
  'http://localhost:8080/api/v1/users/by-username?username=testuser18' \
  -H 'accept: */*'

 

정확하게 email이 일치하는 값만 조회

curl -X 'GET' \
  'http://localhost:8080/api/v1/users/by-email?email=test1818%40test.com' \
  -H 'accept: */*'

 

전체 이용자 정보 조회

curl -X 'GET' \
  'http://localhost:8080/api/v1/users/' \
  -H 'accept: */*'

 

특정 이용자 데이터 삭제

64f59183f3dc171b96a450a5

curl -X 'DELETE' \
  'http://localhost:8080/api/v1/users/64f59183f3dc171b96a450a5/delete' \
  -H 'accept: */*'

 - 삭제 전

 - 삭제 후