240124 TIL |

Error Code

http 상태 코드 이외에 애플리케이션의 error 를 별도 정의할 필요성이 있다.

http 상태 코드 안에서 세부적으로 나눈다고 보면 될 것 같다. 상황에 따라 전달할 수 있어 api 문서의 가독성이 높아진다.

그렇기 때문에 단순히 따로 정의한 code 만 반환하는 것이 아니라 human-readble 한 정보를 포함하도록 한다.

 

RF7808 에서 제시한 형태처럼 분류를 할 수도 있고

{
"type": "/errors/incorrect-user-pass",
"title": "Incorrect username or password.",
"status": 401,
"detail": "Authentication failed due to incorrect username or password.",
"instance": "/login/log/abc123"
}

kakao 처럼 서버에서 전달한 에러를 음수값으로 표현할 수도 있다.

HTTP/1.1 400 Bad Request
{
"code":-10,
"msg":"API limit has been exceeded."
}

 

정의하기 나름!

enum 클래스를 생성해서 불러온다.

 

---

 

깃헙 Issues

새로운 이슈 생성

팀원이 설정해놓은 템플릿을 이용했다.

이슈를 올려놓으면 그 아래로 의견을 차례로 나눌 수 있다.

 

 

이렇게 생성해놓은 이슈는 pull request 를 할 때 이슈 아이디를 태그해서 걸어올 수 있고

해당 pull request 를 최종 merge 하게 되면 이슈가 closed 된다.

 

 

깃헙 코드 리뷰/코멘트

pull request 로 올려놓은 코드의 원하는 부분에 코멘트를 달 수 있다.

 

 

 

---

협업을 몰랐을 때는 단순히 같이 주제를 정하고 분업을 하고 합치는 걸로만 알고 있었다.

세세하게 들어가니 함께 기획하고 정해야할 것들이 정말 많았다.

이전에는 내가 맡은 기능을 push 하고 merge 하기만 급급했는데 추가하고싶은 기능이 있거나 논의가 필요한 부분을 간편하게 공유할 수 있고 그걸 최종적로 push 한 코드와 함께 올릴 수 있다니 정말 유용하고 재밌다.! 이번 프로젝트를 통해 사용할 수 있게 돼서 다행이다. 한 가지 아쉬운건 아직 코드 컨벤션/ 깃 컨벤션을 정하지 못했다는 점이다. error code 라도 다같이 정해서 목록도 정리하고 결과물도 보고싶다.

배포하는 과정을 겪는 것만으로도 많이 배워갈 수 있을 것 같은데 그 이외에도 내가 이 프로젝트에서 뭘 가져갈 수 있는지 계속 찾고 잊지말자.