API 문서란 무엇인가

우선 API문서를 알아보기 이전에 API라는 게 무엇인가를 알아보자면, 클라이언트는 서버에게 요청을 보낸다. 그러면 서버는 클라이언트의 요청에 맞게 맞는 처리를 한다.

그런데 이러한 요청을 받고 올바를 처리가 되게끔 하는 체계가 바로 API라고 한다. 예를 들어서 로그인 요청을 보내면 그에 맞게 응답을 해야하고 그에 맞는 화면이 나와야한다.

회원가입 버튼을 누르면 컴퓨터 화면에 회원가입을 할 수 있는 창이 떠야한다. 이렇게 올바른 처리를 하게끔 되기 위해서 클라이언트와 서버의 원활한 신호를 주고 받을 수 있게끔 되도록 만든 체계가 바로 API라고 보면 된다.

이러한 API 체계를 문서화하여 만든 것을 바로 API문서라고 한다. 이러한 API문서는 회사마다 스타일이 조금씩 다르고 상황에 따라 문서는 계속 업데이트 된다.

그리고 참고로 API 문서는 보통 깃북(GitBook)을 활용한다. IT분야로 취업을 하고자 한다면?

위에서 간단하게 API와 API문서에 대한 개념을 정리 해보았는데...