💁‍♂️ : 쿼리냐 파람스냣

• 오늘 한것
  • 서버 레포지토리 기본 폴더구조
  • api 명세 초안 작성

RESTful API 적용과 API 명세서 작성 회고

RESTful API 구현

처음에는 API를 어떻게 설계하고 구현할지에 대한 명확한 방향이 필요했습니다. RESTful 아키텍처를 따르기로 결정하고 HTTP 메서드(GET, POST, PUT, DELETE)를 올바르게 활용하고자 했습니다. 또한 URI(Uniform Resource Identifier)를 명확하게 정의하고, 상태 코드를 적절하게 사용하여 API의 일관성을 유지하고 싶었습니다

API 명세서 작성

API 명세서 작성은 다른 개발자나 클라이언트 팀과의 원활한 커뮤니케이션을 위해 핵심적인 단계였습니다. Swagger 또는 OpenAPI Specification과 같은 도구를 사용하여 API 문서를 작성할 수도 있지만, notion에 API 명세서를 작성하였습니다. 각 엔드포인트의 설명, 요청 및 응답 예제, 인증 방법 및 버전 관리 등을 포함했습니다.

교훈

API를 설계할 때 리소스 중심으로 접근하고자 노력했으나, 처음에 어떤 것을 리소스로 정의해야 하는지 이해하는 데 어려움을 겪었습니다. 또한, 파라미터를 어떻게 전송해야 하는지에 대한 혼란도 있었습니다.

리소스 식별의 어려움

처음에는 어떤 것을 리소스로 표현해야 하는지 명확히 이해하지 못했습니다. 예를 들어, 사용자, 제품, 주문과 같은 개념은 리소스로 자연스럽게 떠올랐지만, 기타 개념은 어떤 식으로 정의해야 하는지에 대한 고민이 필요했습니다.

파라미터 전송 방식 혼란

API를 호출할 때 파라미터를 어떻게 전송해야 하는지에 대한 혼란도 있었습니다. 파라미터를 경로(path)에 포함할지, 쿼리(query) 문자열로 전송할지 결정하는 것이 쉽지 않았습니다.

극복과 배운 점

위 어려움을 극복하기 위해 RESTful 설계 원칙과 리소스 식별에 대한 추가적인 학습을 진행했습니다. 이러한 노력을 통해 API 엔드포인트가 각 리소스와 연결되도록 설계하는 방법을 습득하게 되었습니다. 또한, 경험을 통해 어떤 경우에 파라미터를 경로에, 어떤 경우에는 쿼리 문자열로 전송해야 하는지에 대한 기준을 확립했습니다.