시작하기전

  • 여지껏 들어봤거나, 듣고 있거나, 앞으로 일하면서 들을 용어들을 설명을 할 것이다.
  • 그렇게 깊이 있는 지식이 아닌, 초심자들이 들었을때도 아 ~ 그렇구나~ 라고 끄덕거리게 하는게 목표이니 개념만 쉽게 이해하고 심도있는 내용을 추구하는 사람들은 구글링을 통해 더 깊이 있는 내용을 공부하기 바란다.


은행을 서버라고 한다면

  • Q. 은행에 가서 내 통장 잔고를 확인하는 방법은?
    1. 아무나에게 가서 물어본다.
    2. 대출 창구에 간다.
    3. 크게 힘차게 소리친다.
    4. 번호표를 뽑고 입출금 창구에 가서 민증을 보여준다.
  • 당연히 정답은 4번이다. 은행과 우리와의 규칙(약속)이 있기 때문
  • 즉, 은행과 미리 약속해둔 곳에 약속해둔 데이터(신분증)을 들고 가야 잔고를 알려준다.(응답)

  • 아마 배민 서버에서는 이렇게 되어 있을 것이다.
    • 이 ABC를 API라고 한다. Application Programming Interface라고 하는데 여기까지는 알필요 없고 API만 알고 있도록 하자.
  • API란?
    • 서버측에서 만들어 놓은 기능이자 클라이언트 개발자(Front-end)와의 약속이다.
  • API 문서화
    • 개발을 하다보면 만들어진 API와 만들어야 할 API양이 어마어마하게 많아진다.
    • 별거 없다. 그냥 헷갈리니까 문서로 써둘까? 라고 하는게 API문서화다.
  • API 문서화 예시
    POST /users
    

    /users로 들어오시고

Request

{
    "id": "abc",
    "password": " ",
    "user_num": 1,
    "name": "아무개",
    "sex": "남",
    "phone_number": "010-2222-3333"
}

이런 데이터를 가져오시면

SUCCESS {"code":200, "message": "Success"}

이런 데이터를 제가 드리겠습니다. 라고 문서화를 시켜놓는게 API문서화라고 보면 된다. 자세한 예시는 구글링을 하여 보면 된다.


그래서 API는 어떻게 생겼냐?

  • 여러가지 생김새가 있지만 대표적인 예시를 한번 보겠다.

https://movie.naver.com/movie/bi/mi/basic.naver?code=18871# 이 링크를 들어가면 네이버 영화페이지에 노킹 온 헤븐스 도어 라는 영화가 나온다.

  • 자 여기서 자세히 보면
    • https://movie.naver.com : 서버 위치
    • /movie/bi/mi/basic.naver : API주소
    • code=18871# : 가져가기로 한 데이터(18871은 노킹 온 헤븐스 도어가 나오지만 18872는 이방인 이라는 영화가 나온다.)

Tags:

Categories:

Updated:

Leave a comment