REST API 설계 & 문서화
·
TIL
웹 애플리케이션이 성장할수록 일관성 있는 API 설계와 명확한 문서화는 유지보수성과 확장성의 핵심입니다. 이번 포스트에서는 RESTful URI 설계 원칙, 응답 형태 통일, Swagger/OpenAPI 사용법을 알아보겠습니다.1. RESTful한 URI 설계 원칙1-1. 리소스(resource) 중심 설계URI는 행위(동사)가 아니라 명사(리소스) 로 표현합니다.예: /orders (주문 목록), /orders/{orderId} (특정 주문)1-2. HTTP 메서드 활용메서드의미예시GET조회(Read)GET /users, GET /users/123POST생성(Create)POST /usersPUT전체 갱신PUT /users/123PATCH부분 갱신PATCH /users/123DELETE삭제(Delete..