.env파일을 만들어야 합니다.- env 파일은 다음 env 예제 파일(
.env.example)의 형식을 참고해주세요.LOCAL_MYSQL_ROOT_PASSWORD=<MYSQL의 ROOT password> LOCAL_MYSQL_USERNAME=<MYSQL의 DB username> LOCAL_MYSQL_PASSWORD=<MYSQL의 DB password> LOCAL_MYSQL_VOLUME_PATH=./bin/mysql # MYSQL 데이터를 저장할 본인 컴퓨터 경로 LOCAL_MYSQL_PORT=3306 # 컴퓨터에서 사용할 PORT LOCAL_REDIS_VOLUME_PATH=./bin/redis # REDIS 데이터를 저장할 본인 컴퓨터 경로 LOCAL_REDIS_PORT=6379 # 컴퓨터에서 사용할 REDIS PORT KAKAO_API_KEY=<Kakao API Key> # 개인의 Kakao Open API key - docker compose를 사용하여 mysql과 redis 데이터베이스 환경을 만들어야 합니다.
- 인텔리제이의 docker plugin 기능을 사용하시거나, 다음 명령어를 입력해서 데이터베이스 환경을 구성하세요.
docker compose up
| 이름 | 역할 |
|---|---|
| 한상우 | 조장, 여행 도메인 개발, 문서 관리 |
| 구자현 | 설계, git 관리, Security, 공통 처리 |
| 박경탁 | 여행 도메인 개발 |
| 심재철 | 여정 도메인 개발 |
| 이민균 | 여정 도메인 개발 |
- 프로젝트 기간: 11월 10일(금) ~ 11월 16일(목)
- 이번 3차 프로젝트는 지난 프로젝트에 추가적으로 여행에 좋아요, 댓글 기능을 구현했습니다.
- Spring Security를 활용하여 사용자 검증을 진행합니다.
- 사용자는 타인의 여행정보에 좋아요, 댓글 기능을 사용할 수 있습니다.
- 사용자 자신이 좋아요를 누른 여행 목록을 조회할 수 있습니다.
- 여행 및 여정 정보를 조회, 등록, 수정할 수 있는 Spring Boot 기반 RESTful API 서버입니다.
- 여행 및 여정 정보, 사용자 정보는 관계형 데이터베이스(Mysql)에 저장됩니다.
- 3-Layered(Controller-Service-Repository) 패턴으로 설계했습니다.
- Swagger를 통해 API를 문서화했습니다.
- 사전에 코드 컨벤션과 git 컨벤션을 정한 뒤 개발을 진행했습니다.
- Github의 Issue와 Pull Request 기능을 활용하여 개발했습니다.
- 여행과 여정 컨트롤러, 사용자 컨트롤러의 통합 테스트 코드를 작성했습니다.
- 자바 버전 : 17
- 스프링 버전 : Spring Boot 3
- 데이터베이스 : Mysql, Redis, (h2-test용) (+ docker-compose)
- 문서화 도구 : Swagger
- 의존성(자세한 내용은 build.gradle을 참고해주세요!)
- data-JPA
- validation
- security
- lombok
- jjwt
API 문서는 서버를 구동한 뒤, 다음 링크의 Swagger UI에서 확인해 보실 수 있습니다.
http://localhost:8080/swagger-ui/index.html
다음 포스트맨에서도 API 문서를 확인해 보실 수 있습니다.
ERDCloud 사이트 링크 에서도 확인해보실 수 있습니다.
Project
├── HELP.md
├── build.gradle
├── gradle
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── readme.md
├── settings.gradle
└── src
├── main
│ ├── java
│ │ └── com
│ │ └── kdt_y_be_toy_project2
│ │ ├── domain
│ │ │ ├── itinerary
│ │ │ │ ├── api
│ │ │ │ ├── controller
│ │ │ │ ├── domain
│ │ │ │ ├── dto
│ │ │ │ ├── exception
│ │ │ │ ├── repository
│ │ │ │ └── service
│ │ │ ├── member
│ │ │ │ ├── controller
│ │ │ │ ├── domain
│ │ │ │ ├── dto
│ │ │ │ │ └── request
│ │ │ │ ├── exception
│ │ │ │ ├── repository
│ │ │ │ └── service
│ │ │ ├── model
│ │ │ │ └── exception
│ │ │ └── trip
│ │ │ ├── controller
│ │ │ ├── domain
│ │ │ ├── dto
│ │ │ ├── exception
│ │ │ ├── repository
│ │ │ └── service
│ │ └── global
│ │ ├── config
│ │ ├── error
│ │ ├── jwt
│ │ ├── resolver
│ │ ├── security
│ │ └── util
│ └── resources
│ ├── application.properties
│ ├── static
│ └── templates
└── test
└── java
└── com
└── kdt_y_be_toy_project2
├── domain
│ └── trip
│ │ ├── controller
│ │ ├── repository
│ │ └── service
│ └── itinerary
│ │ ├── controller
│ │ ├── repository
│ │ └── service
│ └── model
├── global
│ ├── factory
│ ├── helper
│ └── jwt
│ └── service
│
└── integration