RESTful API Best Practices

REST API 에 대해 짧게 잘 정리 된 것 같아 공유합니다.

왜 사용 하는지

웹 개발에서 REST API는 클라이언트와 서버 간 통신을 원활하게 하는 중요한 역할을 합니다.

핵심 요약

1. 데이터를 보내거나 받을 때 JSON 포맷을 사용하세요

2. 엔드포인트에서는 동사 대신 명사를 사용하세요

3. 복수 명사를 사용하세요

4. 에러 핸들링을 위해 상태 코드를 사용하세요

5. 관계를 보여주기 위해 엔드포인트를 중첩해 사용하세요

6. 데이터를 받을 때 필터링, 정렬, 페이지를 나누세요

7. 보안을 위해 SSL을 적용하세요

8. 버전을 명시하세요

9. 정확한 API 문서를 제공하세요