PM을 위한 API 해설
카테고리
[성장의 피땀눈물]
태그
마인드셋
직무 분석
커뮤니케이션
요약
PM과 소프트웨어 엔지니어가 레스토랑에 들어갑니다.엔지니어는 PM에게 API가 무엇이며 어떻게 작동하는지 레스토랑 일에 비유하면서 설명하기 시작합니다.
인증 (Authentication)
엔지니어: 회원 전용인 멋진 레스토랑에 간다고 상상해 보세요. 클럽 회원 자격이 있어야 레스토랑에서 식사를 할 수 있습니다.
PM: API에서 이것이 의미하는 바는 무엇인가요?
엔지니어: 레스토랑에 입장하려면 요트 클럽 레스토랑에 입장할 수 있는 신분증과 유효한 멤버십 카드가 필요합니다. 기술 용어로 API 사용 인증을 받으려면 ‘API 키 또는 토큰’ 이 필요합니다.
엔드포인트/목적지(Endpoint)
PM: 식당으로 가는 주소와 길을 알려주시겠습니까?
엔지니어: 주소는 '엔드포인트(http://xxx.com)'라고 부릅니다!
메소드, 요청과 응답 (Method, Request and Response)
PM: 이제 레스토랑에 도착했으니 음식을 주문하죠!
엔지니어: 여기 있습니다,
Method = Get
GET method 는 지정된 리소스의 서버에서 데이터를 검색하는 데 사용됩니다. (‘Method’ 는 API에 수행하도록 요청하는 '동사' 또는 '동작'일 뿐입니다.) 이 시나리오에서는 웨이터에게 레스토랑에서 제공되는 메뉴를 요청했습니다.
Request: 레스토랑에서 제공되는 항목 목록을 보도록 요청했습니다.
Response: 응답의 결과는 레스토랑에서 제공되는 항목 목록을 보여주는 메뉴를 얻는 것입니다.
Method = Post
상상의 요트 클럽 레스토랑에서는 원하는 음식을 찾지 못해 레스토랑의 주방장에게 전화를 걸어 맞춤형 “비건 버거” 새로운 요리를 요청합니다. 그리고 요리사는 이 새로운 항목을 메뉴에 추가하기로 결정했습니다!
이 시나리오에서 메뉴에 새 항목을 넣는 행위를 'Post‘ 라고 합니다.
Request: 셰프가 새로운 “비건 버거” 메뉴를 추가합니다. 요청에는 메뉴에 게시할 설명 및 가격과 함께 항목 이름이 포함되어야 합니다.
Response: 이 결과 '설명' 및 '가격'과 함께 “비건 버거”가 게시되고 메뉴에 표시됩니다.
Method = Put
“비건 버거”는 레스토랑에서 큰 인기를 얻었지만 터무니없는 가격에 요리사는 가격을 몇 달러 인하하기로 결정합니다.
이 시나리오에서 메뉴의 기존 항목을 업데이트하는 작업을 'Put'이라고 합니다.
Request: 셰프가 “비건 버거” 항목의 새 가격을 입력합니다. 요청 페이로드에는 업데이트 중인 항목의 참조 및 값과 함께 업데이트가 필요한 매개변수가 포함되어야 합니다.
Response: 이 결과 메뉴에서 “비건 버거”가격이 업데이트됩니다.
Method = Delete
“비건 버거”에 대한 수요가 급증하자 요리사는 메뉴에서 인기없는 다른 메뉴를 제거하기로 결정합니다.
아이템을 제거하는 행위를. API 용어로 ’Delete’ 라고 합니다.
Request: 셰프가 메뉴에서 '캐비아'를 제거해 달라고 요청할 것입니다. 요청 페이로드에는 메뉴에서 제거할 다른 세부 정보 중에서 항목 이름이 포함되어야 합니다.
Response: 이 결과 메뉴에서 '캐비아'가 더 이상 표시되지 않습니다.
상태 코드와 오류 메세지 (API Status Codes and Error Messages)
PM: 와우! API가 원하는 모든 작업을 수행한다는 사실이 마음에 드는군요.
엔지니어: API가 항상 잘 작동하는 것은 아닙니다. 종종 오류도 발생합니다. 아래 '응답 코드'를 통해 API의 동작 상태를 확인할 수 있습니다.
2xx : 요청이 성공했음을 의미합니다.
3xx : 운전을 해서 상상의 요트 클럽 레스토랑으로 가서 새 주소로 이사했다는 안내판과 호텔 직원이 새 위치 방향을 알려주는 안내판을 찾았다고 상상해 보세요. API 용어로 요청이 다른 URL로 리디렉션됨을 의미합니다.
4xx: 레스토랑으로 차를 몰고 가 '캐비아'를 주문했는데 더 이상 레스토랑에서 제공되지 않는다는 사실을 알게 되었습니다! 이는 클라이언트 오류(승인되지 않음, 금지됨, 페이지를 찾을 수 없음)와 동일합니다.
5xx: 이 경우에는 레스토랑의 문제입니다! 비건 버거를 주문했지만 대기열이 길고 항목을 만드는 데 시간이 오래 걸렸습니다. API 용어로 그것은 서비스를 사용할 수 없거나 게이트웨이 시간 초과를 의미합니다.
인증 (Authentication)
엔지니어: 회원 전용인 멋진 레스토랑에 간다고 상상해 보세요. 클럽 회원 자격이 있어야 레스토랑에서 식사를 할 수 있습니다.
PM: API에서 이것이 의미하는 바는 무엇인가요?
엔지니어: 레스토랑에 입장하려면 요트 클럽 레스토랑에 입장할 수 있는 신분증과 유효한 멤버십 카드가 필요합니다. 기술 용어로 API 사용 인증을 받으려면 ‘API 키 또는 토큰’ 이 필요합니다.
엔드포인트/목적지(Endpoint)
PM: 식당으로 가는 주소와 길을 알려주시겠습니까?
엔지니어: 주소는 '엔드포인트(http://xxx.com)'라고 부릅니다!
메소드, 요청과 응답 (Method, Request and Response)
PM: 이제 레스토랑에 도착했으니 음식을 주문하죠!
엔지니어: 여기 있습니다,
Method = Get
GET method 는 지정된 리소스의 서버에서 데이터를 검색하는 데 사용됩니다. (‘Method’ 는 API에 수행하도록 요청하는 '동사' 또는 '동작'일 뿐입니다.) 이 시나리오에서는 웨이터에게 레스토랑에서 제공되는 메뉴를 요청했습니다.
Request: 레스토랑에서 제공되는 항목 목록을 보도록 요청했습니다.
Response: 응답의 결과는 레스토랑에서 제공되는 항목 목록을 보여주는 메뉴를 얻는 것입니다.
Method = Post
상상의 요트 클럽 레스토랑에서는 원하는 음식을 찾지 못해 레스토랑의 주방장에게 전화를 걸어 맞춤형 “비건 버거” 새로운 요리를 요청합니다. 그리고 요리사는 이 새로운 항목을 메뉴에 추가하기로 결정했습니다!
이 시나리오에서 메뉴에 새 항목을 넣는 행위를 'Post‘ 라고 합니다.
Request: 셰프가 새로운 “비건 버거” 메뉴를 추가합니다. 요청에는 메뉴에 게시할 설명 및 가격과 함께 항목 이름이 포함되어야 합니다.
Response: 이 결과 '설명' 및 '가격'과 함께 “비건 버거”가 게시되고 메뉴에 표시됩니다.
Method = Put
“비건 버거”는 레스토랑에서 큰 인기를 얻었지만 터무니없는 가격에 요리사는 가격을 몇 달러 인하하기로 결정합니다.
이 시나리오에서 메뉴의 기존 항목을 업데이트하는 작업을 'Put'이라고 합니다.
Request: 셰프가 “비건 버거” 항목의 새 가격을 입력합니다. 요청 페이로드에는 업데이트 중인 항목의 참조 및 값과 함께 업데이트가 필요한 매개변수가 포함되어야 합니다.
Response: 이 결과 메뉴에서 “비건 버거”가격이 업데이트됩니다.
Method = Delete
“비건 버거”에 대한 수요가 급증하자 요리사는 메뉴에서 인기없는 다른 메뉴를 제거하기로 결정합니다.
아이템을 제거하는 행위를. API 용어로 ’Delete’ 라고 합니다.
Request: 셰프가 메뉴에서 '캐비아'를 제거해 달라고 요청할 것입니다. 요청 페이로드에는 메뉴에서 제거할 다른 세부 정보 중에서 항목 이름이 포함되어야 합니다.
Response: 이 결과 메뉴에서 '캐비아'가 더 이상 표시되지 않습니다.
상태 코드와 오류 메세지 (API Status Codes and Error Messages)
PM: 와우! API가 원하는 모든 작업을 수행한다는 사실이 마음에 드는군요.
엔지니어: API가 항상 잘 작동하는 것은 아닙니다. 종종 오류도 발생합니다. 아래 '응답 코드'를 통해 API의 동작 상태를 확인할 수 있습니다.
2xx : 요청이 성공했음을 의미합니다.
3xx : 운전을 해서 상상의 요트 클럽 레스토랑으로 가서 새 주소로 이사했다는 안내판과 호텔 직원이 새 위치 방향을 알려주는 안내판을 찾았다고 상상해 보세요. API 용어로 요청이 다른 URL로 리디렉션됨을 의미합니다.
4xx: 레스토랑으로 차를 몰고 가 '캐비아'를 주문했는데 더 이상 레스토랑에서 제공되지 않는다는 사실을 알게 되었습니다! 이는 클라이언트 오류(승인되지 않음, 금지됨, 페이지를 찾을 수 없음)와 동일합니다.
5xx: 이 경우에는 레스토랑의 문제입니다! 비건 버거를 주문했지만 대기열이 길고 항목을 만드는 데 시간이 오래 걸렸습니다. API 용어로 그것은 서비스를 사용할 수 없거나 게이트웨이 시간 초과를 의미합니다.🧑🏻⚕️ 요약자
관심 분야
타겟 오디언스
공유 날짜
2022/04/11
5 more properties