질문Q #2953
API 서버를 만들다가 궁금증이 생겼습니다.
방문넷2014-11-17 04:04:27
지금 개발하는 API 서버 여건상 서버끼리만 통신하는 API를 만들고있습니다.

서버는 코드이그나이터 3.0으로 직접 손수 코딩중이구요

클라이언트는 curl로 신호를 요청하는중이구요..

개발계속 하다가 궁금한점이 생겼는데요

API 서버 개발하시는분들은 대게 에러코드를 어떤 기준으로 잡고 에러코드를 기입해두시나요..

여기서 제가 말하는 에러코드란 그냥 숫자를 의미 합니다.

200, 404, 500과 같이 프로그램상의 에러코드를 뜻합니다.



의뢰한 업체에서 서버 작성함과 동시에 메뉴얼을 만들어달라해서....... 일단 만들고 있긴한데요.....
제가 에러코드를 고민하는데 되게 모양새 안나오는 기분이고.. 흑......그냥 고민입니다 100번부터 시작해서 쭈욱 이어 나갈까싶기도하고;;;

여러분의 조언을 좀 듣고싶습니다.
답변10
#1 수야디벨 2014-11-17 10:06:41
저 같은 경우는 보통 SUCCESS의 의미가 있는 , 즉 성공이나 OK , 문제 없음을 뜻하는건 

100 , 200 , 300 처럼 백단위의 숫자, 즉 딱 떨어지는 숫자로 하고 ,

오류가 생기면 그 딱 떨어지는 숫자의 기준으로 XX1 ..XX2.. 식으로 합니다.

예를 들어서 로그인 성공을 100 으로 처리했습니다.

그럼 로그인과 관련된 오류는 101 .. 102.. 103.. 이런식으로 하고 ,

게시물 등록 성공은 200 으로 했다면

게시물 등록과정중 실패할 경우 201.. 202.. 로한다는거지요 ㅎ

물론 저도 정확한 기준은 모르지만 제 기준이 도움이 될까하여 답변드립니다 ~
#2 taegon 2014-11-17 10:19:32
저는 성공은 0으로 두고 나머지에 대해 에러 번호를 만듭니다. 1 ~ 99까지는 시스템 오류(데이터베이스, 파라미터 없음 등), 100 ~ 199는 계정 관련 오류 이런 식으로 범위를 놓고 에러 번호를 만듭니다. 어짜피 기준은 만드는 사람이 정하는 것이니 지금 처럼 만드셔도 괜찮습니다. 다만 나중에 확장해 갈 수 있는 API라면 에러 번호를 만들때 충분한 여유 번호를 두고 만드시는 것도 좋을 듯합니다.
#3 kaido 2014-11-17 10:23:26
저의경우엔 HTTP 상태 코드는 준수합니다.

1XX 조건부응답
2XX 성공
3XX 리다이렉션
4XX 에러
5XX 서버오류

기본 코드를 제외한
1000~ 대부터 시작 한다든지 말이죠.
#4 인스카 2014-11-17 10:42:36
저도 HTTP 상태코드를 그대로 사용해요.. 서버에러면 500대, 사용자 요청 오류면 400대, 어쨌든 성공이면 200대...
#5 인스카 2014-11-17 12:30:15
혹시.. API에서(REST?) HTTP Status Code를 주지 않고, response body에 result code를 넣어서 보내나요??
#6 방문넷 2014-11-17 14:48:16
인스카 // 네.. http Header로 지지고 볶고 할려했는데 제가 자신있는 분야가 아니라서요 ㅎㅎㅎ;;;

인스카, kaido // 아 그렇군용... http 상태코드를 보고 겹치지않게 작업하는게 덜 헷갈리겠네요 정보감사합니다.

teagon // 아하 저도 코딩을 할때 ErrorCode == 0 일때는 성공 처리를 해버려서요 ㅎㅎ;;; 확장까지 고려한다라면 한번 진득히 생각 해봐야겠습니다 정보감사합니다!''

수야디벨 // 아하! 100단위로 쪼개서 작업하면 나름 메뉴얼 만들때 좋겠네요 으흐흐.그렇지않아도 문서 작성할때 생각없이 작성해서 수야디벨님의 방법대로 진행중이었다는걸 이제야 깨닳았네요... 답변 주신분들의 정보를 좀더 부합해서 깔끔하게 작업좀 해봐야겠습니다

모두 답변을 상세히 적어주셔서 너무나 감사합니다 (--)(__)
#7 인스카 2014-11-17 14:59:24
REST API라면 더더욱 header의 표준 HTTP Status Code를 활용해 보세요 ㅎㅎ 그럼 굳이 response body에 result code를 정의해서 넣고, body가 제대로 전달됐는지 전달되지 않았는지 확인 할 필요도 없고요.. ^^
#8 방문넷 2014-11-17 17:44:24
인스카 // Rest API로 처리할려고 했는데요 아직 표준 Http값을 다 몰르고 공부해야되서요 ㅎㅎ;; 제가 그나마 빨리빨리 쳐냈던게 body에 넣었던거거든요 ;; 일단 공부 할겸 Header 에 넣는것도 봐야겠습니다. 정보 감사합니다!
#9 변종원(웅파) 2014-11-17 18:47:00
헤더로 보내는 것 아니면 편할대로 규칙 만드시고 적용하시면 됩니다.
#10 한대승(불의회상) 2014-11-17 19:26:52
방문넷// Restful 서버 작업 할 때 저도 고민 꽤나 했었는데 구현 해 놓고 보니 내맘대로 서버더군요.
Restful 맛보기 파일 등록해 두었으니 훑어보셔요. ^^

http://cikorea.net/file/view/209/page/1