🕊️ REST API 디자인을 위한 모범 사례

📌 JSON을 사용하라. 📌 URI Path에 동사 대신 명사를 사용하라. www.api.example.com/v1/add_employees (X) POST www.api.example.com/v1/employees (O) 📌 정확한 HTTP 상태 코드를 이용하여 응답을 구성하라. 📌 API 엔드포인트 보안 인증과 권한 부여 메커니즘을 포함하라. 📌 API 엔드포인트를 사용한 페이지네이션을 만들어라. GET www.api.example.com/v1/employees?page_limit=250&page_index=1 📌 API 엔드포인트를 사용한 정렬을 허용하라. GET www.api.example.com/v1/employees?sort=salary&sort_type=asc 📌 파라미터를 사용한 필터링을 허용하라. GET www.api.example.com/v1/employees?id=3&isactive=true 📌 API 요청 수에 제한을 걸어라. 📌 API 버저닝 Version 1: www.api.example.com/v1/employees Version 2: www.api.example.com/v2/employees 📌 API 문서를 작성하라.