f-lab-edu / food-reservation

food-reservation

프로젝트 실행 방법

프로젝트 실행, 개발을 위해 스크립트가 준비되어 있습니다.

• 로컬에서 프로젝트 실행
  • docker compose를 이용하여 프로젝트에 필요한 모든 서비스들을 로컬에서 생성하고 실행합니다.
  • 실행 방법
    • 터미널을 프로젝트 루트에 위치시킨 후 아래의 명령어를 입력해 주세요.

      • $ export JEP=... # jasypt encryptor password 값을 "JEP" 환경변수에 넣어줍니다.    
        $ sh script/dev.sh # 스크립트를 실행합니다.

• 로컬에서 앱을 제외한 환경(db 등)만 세팅
  • docker compose를 이용하여 로컬에서 앱을 제외한 나머지 서비스들을 실행합니다.
  • 이 후, IDE 등을 이용해 로컬에서 앱을 개발합니다.
  • 실행 방법
    • 터미널을 프로젝트 루트에 위치시킨 후 아래의 명령어를 입력해 주세요.

      • $ sh script/dev-env.sh

    • IDE 실행 옵션을 다음과 같이 세팅한 후 앱을 실행시킵니다.
      • spring.active.profile=dev
      • JEP=...

인프라 설정 방법

링크

API Schema

Rules

• Git branch naming
• GitHub PR naming

Technical Issues

기술적으로 고민했던 부분을 정리하였습니다.

• enum vs. 테이블 - 진행 중
• 연관관계 annotation 사용 여부 - 진행 중
• 비즈니스 로직 위치 - domain vs. service - 진행 중
• 패키지 구조 - 진행 중
• 서비스와 컨트롤러 메서드의 파라미터, 리턴 타입 정책 - 진행 중
• 프론트엔드가 사용하기 쉬운 API 리턴 타입 - 진행 중

ETC

• no new line 경고 해결

food-reservation's Issues

API 리턴 형식

API 리턴 형식에 대해서 논의하고자 합니다.

리턴 형식이 다음을 만족 했으면 합니다.

• 프론트엔드가 사용하기 쉽도록 한다.
• 성공, 실패 모두 커버할 수 있어야 한다.
• 오류 메시지 등을 포함 하거나 포함 안하는 옵션을 적용하기 쉽도록 한다.

제가 제안하고자 하는 방향은 이렇습니다.

성공 시 메시지

{
  "status": "success",
  "successData": {
    "name": "Son Heung-min",
    "age": "30"
  },
  "failData": null
}

• status 필드에 "success"를 넣습니다.
• successData 필드 안에 성공 데이터를 넣습니다. 예를들면 각 컨트롤러 메서드에서 반환하는 DTO를 넣으면 될 것 같습니다.
• failData 필드 값은 null로 합니다.

실패(실패, 오류, 예외 등 성공 이외의 모든 경우)시 메시지

{
  "status": "fail",
  "successData": null,
  "failData": {
    "code": 1234,
    "message": "name 파라미터는 꼭 존재해야 합니다."
  }
}

• status 필드에 "fail"을 넣습니다.
• successData 필드 값은 null로 합니다.
• failData 필드 값은 다음의 2가지 필드 값을 가집니다.
  • code: 해당 실패에 대한 고유 번호입니다. 고유 번호를 통해 어떤 오류나 예외가 발생했는지 쉽게 구별할 수 있습니다.
  • message: 해당 실패에 대해 설명하는 메시지입니다. 실패에 대한 자세한 내용을 숨기고 싶을 때 이 필드를 안 나가도록 변경할 수 있어야 합니다.

이 제안에 대해서 어떻게 생각하시는지요? 😃