REST API 설계 모범사례

1. Json포맷으로 데이터 주고받기

2. Http메서드 작성하기
   (Get / Put / Patch / Delete 등의 동작을 Crud 동사 형태로 코드 작성)
   (엔드포인트 주소는
   1) 명사 형태로 코드 작성
   2) 복수 명사로 코드 작성
   3) 2단계까지 중첩 허용)

• 엔드포인트 = api가 서버에서 자원에 접근할 수 있도록 하는 url

3. Http상태코드 사용하기
   (Error handling하기 위함)

4. 필터링, 정렬, 페이지 나누기 사용하기

5. Ssl로 보안 적용하기

6. 버전 명시하기

7. 정확한 api문서 제공하기
   (해당 api에 대한 엔드포인트,
   해당 엔드포인트에 대한 요청예시,
   다양한 언어지원,
   각 상태코드에 대한 다른 error메시지 리스트 등을 포함시킬 것)

Api문서 툴 ㅡ 스웨거(swagger) 사용 권장
Api테스트 툴 ㅡ 포스트맨(postman) 사용 권장