REST API 문서의 활용

API 문서화

 

· API는 정보를 주고 받기 위한 방법/약속

· API를 사용하기 위해서는 사용 방법을 알아야 함

· API 문서는 API를 사용하는 방법을 명세한 문서

 

REST API 문서화

· 프론트엔드에서 호출 하기 위한 REST API의 정보가 명세 된 문서

- 백엔드 개발자 주도로 프론트엔드 개발자가 함께 설계

- 프론트엔드 개발자는 약속된 REST API 문서에 의존하여 프론트엔드를 개발

 

· 프론트엔드 등 Client에서 호출하고 활용하는데 어려움이 없도록 상세하게 작성 되어야함

 

REST API 문서가 담고 있어야 하는 정보

· REST API 설명

· URI

· HTTP Method

· Request 파라미터 (필수 파라미터와 선택 파라미터)

· Response 데이터 (필수 응답 데이터와 선택 응답 데이터)

· 가능한 에러 코드 및 대응 방법

· 호출 예시