API 문서를 작성하는 이유

API 문서는 무엇인가?

• 백엔드 개발자가 API를 설계한 방식을 적어두어 어떻게 사용하면 되는지 적어둔 문서
• API 설명서

API 문서는 왜 필요한가?

1. 일관성

2. 협업과 유지 보수

3. API 사용도 중 일어난 문제해결 및 디버깅

 

API에 필히 포함되어야 하는 정보

• URL 주소 / HTTP 메서드
• API 설명
• 요청 형태
  • Path Parmas
  • Query Params
  • Body Params
  • 필수 여부
  • 데이터 타입
• 응답 형태
  • 응답 코드(status code)
  • 각 응답 코드별 설명
  • 응답 형태 (response value)
  • 응답 값에서 각 파라미터의 의미
  • 응답 값에서 각 파라미터의 필수 여부
  • 응답 값에서 각 파라미터의 데이터 타입