나만의 게시판 | 기본기부터 배우는 똑똑한 설계법 | ERD & RESTful

카테고리

프로그래밍/소프트웨어 개발

서브카테고리

웹 개발

대상자

• *초보 백엔드 개발자, 프로젝트 협업 팀원**
• 난이도: 중간 (RESTful 원칙 이해 및 적용에 초점)

핵심 요약

• RESTful 설계는 리소스 중심 URI + HTTP 메서드 분리로 기술 부채를 방지
• URI 중복 방지를 위해 /recipes/{id}/comments 형식으로 행위(action) 대신 리소스 명시
• Swagger, Spring REST Docs 등 문서화 도구와의 호환성 향상

섹션별 세부 요약

1. 기존 설계의 문제점

• 행위 중심 URI (/makecomment, /deletecomment) 사용 시 API 중복 및 유지보수 어려움
• 기능 확장 시 URI 수정 필요로 인한 기술 부채 누적
• HTTP 메서드 의미 파악 부족으로 인한 설계 오류

2. RESTful 설계 예시

• URI 구조: /recipes/{id}/comments (댓글 조회/작성), /recipes/{id}/comments/{commentId} (수정/삭제)
• HTTP 메서드 매핑: GET(조회), POST(작성), PUT(수정), DELETE(삭제)
• 리소스 중심 설계로 새로운 기능 추가 시 재사용성 향상

3. 온보딩과 설계의 관계

• 표준화된 설계는 신규 팀원의 이해도 향상 및 버그 발생 시 원인 추적 용이
• 공통 언어(URI, 메서드, 상태코드)로 프론트/백엔드/기획자 간 소통 효율화
• Swagger, Spring REST Docs 활용 시 자동 문서화 가능

4. 설계법의 장기적 효과

• "빠르게 구현" 대신 "제대로 설계"하는 것이 프로젝트 지속 가능성 향상
• 일관된 설계로 팀 협업 효율성 및 개인 기준 형성

결론

• RESTful 원칙 적용 시 URI 중복 방지, 기술 부채 예방, 협업 효율성 증대
• Swagger 도구 활용을 통해 API 문서 자동화
• "제대로 설계"하는 습관은 장기적 개발 생산성에 긍정적 영향