[공통 사항] 현재까지의 서비스 관련 내용

[EeeasyCode]

@opp-13 @jungyuminn
몇 가지 공통으로 가져가야할 사항이 있어 전달드립니다.

1. 각 서비스의 @RequestMapping 이 각 서비스 root path로 지정되었는데, 이를 변경했습니다.

AS-IS

@Tag(name = "A service API", description = "~~ API")
@RestController
@RequestMapping("/a-service")

TO-BE

@Tag(name = "A service API", description = "~~ API")
@RestController

로 @RequestMapping를 제거했습니다.

이유로는 저희 MSA 환경에서 이미 api-gateway 단에서 실제 트래픽이 routing 될 때, 각각의 서비스로 /path 가 지정되어 요청됩니다.
내부 서비스에서 @RequestMapping 로 맵핑하게 될 경우, 요청 path가 /path/path 로 지정되는 문제 + 내부 서비스는 이미 서비스 디스커버리를 통해 지정되어 있기 때문에 따로 명시하지 않아도 될 것 같습니다.

2. yml 파일 이름 수정

기존에 저도 yml 로 지정했었는데, 이를 yaml로 통일해주시면 될 것 같습니다.

3. application.yaml 의 profile 분리

• application.yaml
• application-dev.yaml
• application-local.yaml

로 각각의 profile을 분리하여 관리해주시면 될 것 같습니다.

4. 우테코 convention 사용

우테코에서 제공하는 java convention을 함께 사용해보면 좋을 것 같습니다. 외에도 추가적인 의견 있으시다면 남겨주세요!

5. public API와 인증/인가가 필요한 API 분리

• 인증/인가되지 않은 사용자가 사용할 수 있는 API (ex. 동아리 리스트 조회 등)
• 인증/인가가 필요한 API
  를 분리해야 합니다.

API-Gateway에서 route 규칙을 추가할 예정인데, 우선 인증/인가가 필요하지 않은 API에 대해서 /public 을 명시해주시면 됩니다.
또한, 인증/인가가 필요한 API의 경우와 public API에 대해서는 PR 내용에 기록해주세요.

또, 공유하고 함께 공통으로 가져가야할 사항이 생기면 저도 추가할테니, 다른 분들도 추가해주세요~~!

[EeeasyCode]

@opp-13 @jungyuminn

• development에 바로 push 는 지양해주세요! 이미지 빌드가 push 될때마다 진행되어서 argoCD sync가 계속 안맞는 경우가 생기더라구요!
  저도 최대한 지양하도록 하겠습니다! (거의 api-gateway의 연동 문제 시에만 진행할 것 같습니다.)

[EeeasyCode]

@opp-13 @jungyuminn

• request, response에 관한 DTO의 type을 확실하게 명시해줘야 할 것 같습니다!
  예를 들어, Optional인지 아닌지 등에 대한 명시가 필요합니다.

• branch 관련 컨벤션을 하나 추가해보려고 해요!
  hotfix 관련된 branch는 내가 merge한 내용으로 인해 배포가 실패되었을 때 이를 해결하기 위한 branch로 사용되고,
  hotfix branch가 PR로 올라간 경우 할당된 리뷰어는 최대한 빠르게 리뷰한 뒤 1시간 이내로 merge 되었으면 좋겠어요!