API는 처음 보면 왠지 전문가만 다루는 문서처럼 느껴진다. 하지만 본질은 생각보다 단순하다. 무엇을 보내면, 무엇이 돌아오는지 정한 약속에 가깝다.
그래서 입문 단계에서는 인증, 상태 코드, 헤더를 모두 외우려 하기보다 요청과 응답의 구조부터 이해하는 편이 좋다.
요청은 질문, 응답은 답이다
예를 들어 사용자 정보 주세요라는 요청을 보내면, 서버는 JSON 형태로 이름과 이메일 같은 데이터를 응답할 수 있다. 초보자는 이 데이터 모양을 읽는 연습부터 해야 한다.
API 공부가 막힐 때는 문서 전체를 보지 말고 샘플 요청과 샘플 응답 한 쌍만 읽는 것이 도움이 된다.
API
GET /users/1
{
"id": 1,
"name": "Mina"
}여기서 중요한 것은 문법보다 무엇을 요청했고, 어떤 데이터가 돌아왔는가다.
API 문서를 읽을 때 보는 순서
- 어떤 주소로 요청하는지
- 어떤 방식인지
- 무엇을 보내야 하는지
- 무엇이 돌아오는지
API 문서가 어렵게 보일수록 샘플 요청과 샘플 응답 한 쌍만 먼저 읽는 편이 낫다.
이 글의 포인트
- API는 요청과 응답의 약속으로 이해하면 시작이 쉽다.
- 문서를 처음 읽을 때는 샘플 한 쌍만 정확히 보는 편이 낫다.
- 데이터 모양을 읽는 연습이 API 두려움을 크게 줄인다.