실무
2025년 2월 15일3분
개발팀이 기획자에게 API 정의를 요청할 때
"API 정의서를 써본 적이 없어서요…" 기획자가 알아야 할 API 명세서의 기본 개념.
화면 데이터는 어디서 오는가
기획자가 설계한 화면의 데이터 중에는 DB에서 바로 가져오는 정보도 있지만, 외부 시스템이나 공공정보를 API로 가져오는 데이터도 있습니다. 내부 데이터라도 다양한 채널 대응을 위해 API로 소통하기도 합니다. 이 정보들을 정의한 문서가 API 정의서(명세서)입니다.
POST / GET / PUT / DELETE
데이터를 가져오기만 하는 경우도 있지만 등록·수정·삭제가 모두 있기 때문에 POST(등록)·GET(조회)·PUT(수정)·DELETE(삭제) 구분자를 사용합니다. 예를 들어 로그인 시 Client와 Server가 정보를 주고받는 과정도 API 명세서로 설계합니다.
기획자가 알아야 하는 이유
API 명세서에는 가져올 데이터의 항목(Field)·타입(Type)·설명(Description)과 연결에 필요한 Base URL, Endpoints가 기재됩니다. 기획자가 직접 작성하는 것이 필수는 아니지만, 화면설계에서 어떤 데이터가 어디서 오는지는 정확히 알아야 원활한 설계가 가능하므로 기본 개념은 익혀두는 것이 좋습니다. (원문: blog.naver.com/phk4568)