API Response 관리
속성
기본 Domain 구성 가이드
답변 완료 여부 또는 인지 여부
질문 또는 인지 이유
API Response 내에 Success 와 Fail 상태를 파악하기 위해, message 변수가 필요합니다.
그런데 message 가 다국어를 지원해야하거나, 개발자에게만 message 를 보여주고 실제 유저에게는 다른 유저친화적 메시지를 보내야하는 경우에는 code 를 사용해야 합니다.
ex) API 실패인데, 유저가 값을 잘못 입력해서 실패한 경우
1. code =[ERROR_REQ_PARAM_EMAIL_REGEX], message = 이메일 형식 오류 와 같은 식으로 API Response 를 보냅니다.
2. 클라이언트에서는 message 는 개발자만 확인하고 code = [ERROR~REGEX] 을 ENUM 혹은 constant 에서 “이메일을 올바르게 입력해주세요.” 혹은 핸드폰의 언어상태에 따라 “Please enter the email correctly. ” 라는 문구를 가져와서 화면에 보여준다.