본문 바로가기

백엔드/설계2

REST 원칙과 REST API 설계 방법 "그런 REST API로 괜찮은가"를 참고하여 정리한 내용입니다.   REST란?REpresentational State Transfer의 약자입니다.웹 서비스 아키텍처의 스타일 중 하나로, 네트워크를 통해 클라이언트와 서버가 상호작용하는 방식을 정의하는 방법입니다.인터넷에서 어떻게 정보를 공유할 것인지에 대한 해답으로 1991년 웹(Web)이 등장했습니다. 웹은 HTML이라는 형식으로 정보를 표현하고, 정보들에 대한 식별자로 URI를 선택하고, HTTP라는 프로토콜로 정보를 전송합니다.2000년 Roy T. Fielding은 기존의 웹을 망가트리지 않고 HTTP를 개선할 수 있을지에 대한 논문을 발표했고, 이것이 REST 였습니다.REST API란?REST API는 REST 아키텍처를 따르는 API로,.. 2024. 8. 3.
에러코드 설계 벤치마킹 & NestJS에서 에러 응답 커스텀 방법 문제상황 Nest.js에서 기본 에러 응답 형식은 위와 같습니다. 이렇게 응답을 주면 협업에 어려움이 있을 것 같습니다.일단 에러가 어느 API에서 발생했는지, 언제 발생했는지 알기 어렵습니다.하나의 상태 코드에 대해서도 세부적으로 분류하기 위한 에러 코드도 필요해보입니다. 벤치마킹다른 기업들에서는 어떤 에러 코드 체계를 가지고 운영 중인지 살펴보겠습니다. 1. NAVER WORKS Developers링크 : https://developers.worksmobile.com/kr/docs/error-codesHTTP 상태 코드와 별도의 에러 코드 체계를 가지고, 해당 코드를 응답 본문에 포함시켜주고 있습니다.동일한 상태 코드에 대해서 여러 종류의 에러 코드를 지정해놓았다는 점에서 어떤 에러인지 파악하기 쉬워.. 2024. 8. 1.