유튜브블로그Top 10
내 프로필

데브허브 안내
소개업데이트 소식

데브허브 커뮤니티

How to Design a REST APIs (With Example)

Devtiro

2025. 8. 1.

0

#backend
  • REST API는 HTTP를 기반으로 요청-응답 패턴을 사용하며, HTTP verbs, headers, response codes 등의 기능을 활용합니다. 🌐
  • 웹 리소스는 REST API의 핵심 개념으로, 도메인 객체와 매핑되며 JSON 또는 XML 형식으로 표현됩니다. 📦
  • HTTP verbs (GET, POST, PUT, PATCH, DELETE)를 사용하여 웹 리소스에 대한 CRUD (Create, Read, Update, Delete) 작업을 수행합니다. 🛠️
  • HTTP response codes는 서버가 요청 처리 상태를 클라이언트에게 알리는 데 사용되며, 200번대는 성공, 300번대는 리다이렉션, 400번대는 클라이언트 오류, 500번대는 서버 오류를 나타냅니다. 🔢
  • Query parameters는 URL 경로에 포함하기 어려운 추가 정보를 요청에 제공하는 데 사용되며, 검색, 페이지네이션, 필터링, 정렬 등에 활용됩니다. 🔍
  • HATEOAS (Hypermedia as the Engine of Application State)는 응답에 관련 웹 리소스 링크를 포함하여 클라이언트가 API 구조에 대한 지식 없이 상호 작용할 수 있도록 하는 방식이지만, 구현 복잡성으로 인해 모든 경우에 유용한 것은 아닙니다. 🔗
  • REST API 디자인 프로세스는 UI (User Interface) 기반으로, 웹 리소스 식별, UI 디자인 분석, REST API 디자인, REST API 문서화의 4단계로 구성됩니다. 🎨
  • 도메인 다이어그램을 통해 멤버, 책, 대출과 같은 웹 리소스를 식별하고, UI 디자인을 분석하여 필요한 기능 (예: 책 검색, 대출, 반납)을 파악합니다. 📚
  • UI 디자인 분석을 통해 식별된 기능은 CRUD 관점에서 REST API 엔드포인트로 변환됩니다. 🔄
  • 책 카탈로그 페이지에서는 책 검색 및 목록 조회, 작가 목록 조회 기능이 필요하며, 책 상세 정보 페이지에서는 특정 책 정보 조회 및 대출 기능이 필요합니다. ℹ️
  • 멤버 대시보드 페이지에서는 사용자 대출 목록 조회 및 반납 기능이 필요하며, OpenID Connect 등을 통해 사용자 정보를 얻을 수 있습니다. 👤

Recommanded Videos