/todo-list

미니 프로젝트: TODO List 서비스

Primary LanguageJava

todo-list

미니 프로젝트: TODO List 서비스

실행환경

  • springboot : 2.7.11
  • Java 11
  • H2 Database
  • Spring Data Jpa
  • Spring Security

백엔드 실행 방법

  1. 프로젝트 다운로드
  2. 프로젝트 경로 이동
  3. ./gradlew bootRun 명령어로 애플리케이션 실행

프로젝트를 이해하는데 도움이 되는 정보

  • Login이 완료 되면, 응답 헤더에 JWT토큰을 리턴하고, 인증이 필요한 API는 요청 헤더에 토큰을 기입해야 합니다.

  • Spring Security를 사용한 이유는, 현재는 회원 API에 대한 인가만 필요하지만, 추후 기능이 추가되어 더 많은 권한이 필요 할때, Spring Security의 인가기능을 사용하기 위함입니다.

  • 로그인은 JwtAuthenticationFilter클래스인 커스텀 Filter로 Jwt로그인 Process를 진행합니다.

    • 로그인이 완료되면, 수동으로 AuthenticationToken을 세팅하여 인증처리를 완료 합니다.
    • Form로그인시 동작하는 UsernamePasswordAuthenticationFilter의 상속하여

  • security에서 Default Login API /login는 /auth/login로 변경하였습니다.

  • 요청에 대한 validaiton은 Spring validaiton 라이브러리를 이용하였습니다.

  • 응답 파라미터 중, status에 성공 시 1, 실패 시 -1을 리턴합니다.

    • 프론트 사이드에서 status로 api의 성공/실패 여부를 편리하게 판단하게 하기 위함입니다.

  • 회원가입 페이지 및 부가기능 페이지에서 사용할 비인증 API를 추가하였습니다.

  • Validation로직은 CustomValidationAdvice클래스에서 처리합니다.

  • 편리한 테스트를 위한 더미데이터가 존재합니다.

    • dev 실행환경에서만 동작합니다.
    • id는 user password는 1111 이고, 이 회원이 작성한 하나의 todo 데이터가 존재합니다.

  • 테스트간 독립성을 위해 teardown.sql를 실행합니다.

ERD

image

Request Format

curl --location 'http://localhost:8081/todo' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0b2RvIiwiYWNjb3VudElkIjoidXNlciIsInJvbGUiOiJVU0VSIiwiaWQiOjEsImV4cCI6MTY5NDkzMTE5Mn0.Zv_kcE4KCCF5wcI30HSeF3Zz4q-NKYCa8z_7l4mzF8NtHZeJtTTpOoUg1e3XRVlJ0XutNyA29bNXp6X1Q02Eog' \
--data '{
    "title": "첫번쨰 할일",
    "content": "todo API 만들기"
}'
  • 회원가입, 로그인, 검증 API를 제외한 요청은 헤더에 Bearer로 시작하는 토큰값을 입력해야 합니다.
  • 상세 API는 아래 API 상세 명세서를 참고해주시기 바랍니다.

API 상세 명세서

https://documenter.getpostman.com/view/14221099/2s9YC1XEPH

Response Format

Sucesss

{
  "code": 1,
  "msg": "Todo 추가 성공",
  "data": {
    "id": 2,
    "userId": 1,
    "title": "첫번쨰 할일",
    "createdAt": "2023-09-10 15:33:36"
  }
}

Fail

{
    "code": -1,
    "msg": "로그인을 진행해 주세요.",
    "data": null
}

단위 테스트

image