[API] PM이 API에 대해서 얼마나 알아야 할까?

API 기본 개념 

API(Application Programming Interface)
: 클라이언트, 서버가 서로 다른 프로그램에서 요청과 응답을 주고 받을 수 있게 만든 체계

클라이언트가 기능을 사용하기 위해 서버의 주소로 요청을 보내면
서버가 응답을 해주는 소프트웨어끼리의 체계

 

- 1)요청을 보내는 쪽과 2)응답을 주는 쪽으로 구성 

- API를 통해 요청과 응답을 주고받을 때는 ‘데이터’도 같이 담긴다.

   - 이를 무사히 수행하려면 ‘정확한 곳’에 요청을 보내야 한다 (= 서버주소)

   - 이를테면, 서버주소/A라고 보내면 ‘로그인’을 서버주소/B라고 보내면 ‘회원가입’을 진행한다.

- 서버 프로그램은 ‘서버 개발자’가 개발하고, 서버 주소 정의 역시 서버 개발자의 주도하에 이루어진다.

 

 

☝🏻 API는 서버 개발자가 개발하고, 클라이언트 개발자는 그 API를 사용한다.

클라이언트 관점에서 바라보는 API

 

서버 관점에서 바라보는 API 

• 클라이언트의 요청에 서버가 생각할 수 있는 경우의 수
  • 잘 처리됐을 때 : 200번대 코드
  • 잘 처리되지 않았을 때
    • 클라이언트의 요청이 문제: 400번대 코드 (ex. 404 에러코드)
    • 서버가 문제: 500번대 코드

 

SDK (Software Development Kit): API를 제공해주는 ‘다른 소프트웨어’, 소프트웨어를 개발하기 위한 도구  

구글 지도 SDK를 설치하면 내 소프트웨어에서 구글 지도 기능을 넣을 수 있다.
해당 SDK에서 제공해주는 API를 통해 구글 지도에 요청을 보낼 수 있다.

• JSON: 클라이언트와 서버는 요청과 응답을 주고받고, 그 때 필요한 데이터들을 JSON 형식으로 주고받는다
• API 문서
  • 네이버에서 API 문서를 제공 : Open API
    • Open API를 공개하는 이유
      • 많은 사람들 방문 유도
      • 비즈니스 모델로 활용 (일정 횟수 이상은 돈을 내야 함)

---

 

 

PM이 API를 왜 알아야 할까? 

1.  모든 서비스는 사용자가 생성, 수정, 삭제한 정보가 서버에 반영되고,이 결과를 다시 사용자에게 보여주는 방식이다.
즉, CRUD(Create - Read - Update - Delete)의 과정을 API가 해준다.

 

2. 클라이언트가 서버에 요청을 보낼 때 4가지 요청 유형이 있다: GET, POST, PUT/PATCH, DELETE

출처: 비전공자를 위한 이해할 수 있는 IT 지식

 

PM은 CRUD 관점에서 데이터를 바라볼 줄 알아야 한다. 
만약 CRUD 중 특정 기능이 없는 기획이라면 그 기획 의도를 명확히 해야 하며, 이유를 설명할 수 있어야 한다. 

 

CRUD는 각각의 주소를 가질 수 있는데, 프로덕트 규모가 커질수록 CRUD 주소가 많아져 관리하기가 힘들다. 

그에 RESTful API에서는 CRUD를 하나의 주소로 관리한다. 

    - GET: 정보 조회(read)

    - POST: 정보 생성(Create) 

    - PUT(전체), PATCH(일부): 정보 업데이트(Update) 

    - DELETE: 정보 삭제(Delete) 

3. 이는 직접 만들어 쓸 수도 있고, Open API를 이용할 수도 있다 

   - 네이버에서 API 문서를 제공 : Open API

   - Open API 공개 이유

     1) 많은 사람들이 방문하도록 유도

     2) 비즈니스 모델로 활용 (일정 횟수 이상은 돈을 내야 함)

API 공통 가이드 - Open API 가이드

 

---

참고한 책 및 아티클 

 

비전공자를 위한 이해할 수 있는 IT 지식 | 최원영 - 교보문고

 

초보 기획자/PM을 위한 API 보는 법 (1)