Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 번역 도메인 API, 엔티티 설계 (#54) #55

Merged
merged 2 commits into from
Dec 23, 2023
Merged

feat: 번역 도메인 API, 엔티티 설계 (#54) #55

merged 2 commits into from
Dec 23, 2023

Conversation

seokjin8678
Copy link
Contributor

관련 이슈

PR 세부 내용

번역 도메인의 API와 엔티티를 우선 설계했습니다.

엔티티

번역 요청을 비동기로 처리하기 위해 엔티티의 이름을 TranslateProgression로 하였습니다.
TranslateProgression을 한글로 풀어서 표현한다면 번역 진행 상태가 어울릴 것 같은데, 어떤 이름으로 부르는게 좋을까요..?

또한 뉴스가 중복으로 번역되는 것을 막기 위해 newsId, destinationLanguage를 복합 유니크 인덱스로 설정하였습니다.

message 컬럼은 번역에 실패했을 때 어떤 사유로 번역에 실패했는지 알려주기 위한 컬럼이라고 보시면 됩니다. (타임아웃, 연결 실패, 비용 초과 등)

translationStatus 컬럼으로 번역의 상태를 나타내었습니다. (진행중, 완료, 에러)
에러 보다는 실패(failure)로 할 걸 그랬나 싶네요. 😂

번역 재요청을 하려면 번역의 상태가 실패일때만 진행할 수 있게 비즈니스 로직을 작성할 수 있을 것 같습니다!

API

/api/v1/translation/{newsId} URI로 번역할 언어(destinationLanguage)를 Body에 담아 POST 요청을 보내면 번역 진행 상태의 식별자를 반환합니다. 이때 응답은 200 OK가 아닌, 201 CREATE로 하였습니다. (새로운 자원이 생성되므로)

/api/v1/translation/{translateProgressionId}에 GET 요청을 보내면, 번역 진행 상태의 정보를 반환합니다.


결론은 번역 요청을 보내는 기능을 구현하기 전에 도메인 용어부터 확실하게 정하고 가면 좋을 것 같습니다!

@seokjin8678 seokjin8678 added the 번역 번역 도메인 label Dec 23, 2023
@seokjin8678 seokjin8678 requested a review from Laeng December 23, 2023 11:59
@seokjin8678 seokjin8678 self-assigned this Dec 23, 2023
@seokjin8678 seokjin8678 linked an issue Dec 23, 2023 that may be closed by this pull request
@seokjin8678 seokjin8678 changed the title feat: 번역 도메인 API, 엔티티 설계 feat: 번역 도메인 API, 엔티티 설계 (#54) Dec 23, 2023
Copy link

Test Results

17 files  17 suites   2s ⏱️
46 tests 46 ✅ 0 💤 0 ❌
58 runs  58 ✅ 0 💤 0 ❌

Results for commit dfcfb3f.

@Laeng
Copy link
Member

Laeng commented Dec 23, 2023

저는 TranslateProgression도 마음에 듭니다!
도메인 용어는 정해주시는 대로 따라가겠습니다! 헤헤

@Laeng Laeng merged commit 326de14 into dev Dec 23, 2023
3 checks passed
@Laeng Laeng deleted the feat/#54 branch December 23, 2023 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
번역 번역 도메인
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: 번역 도메인의 API, 엔티티 설계를 진행한다.
2 participants