search

project-soda / soda

1 stars 0 forks source link

Error code 정리 #45

Open daclouds opened 4 years ago

daclouds commented 4 years ago
daclouds commented 4 years ago

related to https://github.com/daclouds/soda/issues/26

DongsuDanielLim commented 4 years ago

npm http-status 사용을 제안합니다. 깃헙 위키에 정리해두었습니다. https://github.com/project-soda/soda/wiki/Server-Error-Codes

daclouds commented 4 years ago

참고로 이 issue 는 http common errors 가 아니라 Application 에 관한 logic errors 를 정리하는 issue 입니다. (wiki 에 적어 주신 내용 중 Custom Errors 에 해당 할 것 같네요. )

https://github.com/project-soda/soda/issues/26 에 @KimHeeSeok 님이 적어 주신 것처럼

"이미 존재하는 아이디/이메일 입니다.", "비밀번호가 틀렸습니다." 의 경우 아래와 같은 형태, 명칭을 정의하고 정리하는 이슈 입니다.

RES_NOK_DUPLICATED_ID / RES_NOK_DUPLICATED_EMAIL RES_NOK_WRONG_PASSWORD (예시로 적은거고 이대로 할 필요는 없습니다. )

daclouds commented 4 years ago
  • [ ] 서버에서 사용하고 있는 에러코드 정리해서 공유 : 포스트맨? 노션? 깃헙위키?

다른 사람의 comment 를 편집 할 수도 있군요; (제가 적은 내용이 아니라 깜짝)

DongsuDanielLim commented 4 years ago

그러면 에러 코드의 창작(?) 이 필요한거죠..? 위에 예시 구조도 좋은 것 같습니다. 지금 모든 에러 케이스를 메시지 딕셔너리로 만들 수는 없을 것 같고 간단한 규칙을 정해서 사용하면 좋을 것 같아요. ex) (대문자로) : [접두사][동사][명사]

서버에서는 코드로 반환하고 클라이언트에서 유저가 이해할 수 있는 메시지로 치환한다면 message 부분이 평문 메시지였는데 이걸 코드 메시지로 바꿔서 사용하면 될 것 같습니다.

{
    "code": "BAD_REQUEST",
    "message": "RES_BAD_PARAMETER" // "Test is required!" 
}