API 문서

- API(Application Programming Interface) :  서버와 클라이언트가 데이터를 주고 받을 수 있도록 도움을 주는 매개체

- 백엔드 개발자에게 API 개발 : 프론트엔드와 주고받을 데이터를 처리하기 위한 서버 프로그램 개발

- API 문서 : 어떤 API를 사용하여 통신할 지 미리 정의한 문서

- 구성

  # 개요

    1. API 소개 : API에 대한 간단한 소개와 개발 배경, 비즈니스 목적과 API의 장점 소개

    2. 공통 요청/응답 형식 :  요청하는 데이터 형식과 

    3. 공통 에러 : API 간 공통되는 에러 코드가 존재한다면, 문서의 한 섹션에 에러 코드를 모아두고 관리

 

  # 시작하기 : 특정 API를 호출하기 전, 선제적 API를 호출해야 하거나 관리자 사이트 등에서 인증키 정보를 획득해야 할 경우

                      시작하기 과정이 필요하여 API의 사용 순서를 설명하는 시작 가이드

    1. 사전 작업 : API 사용에 앞서 인증키를 어떻게 발급할 수 있고 어떤 용도로 사용되는지 상세히 설명

    2. API 사용 시퀀스 : 여러 API를 순서에 맞지 않게 호출하여 원하는 결과를 도출하지 못하는 경우를 없애기 위해

                                    넘버링 형식으로 시퀀스를 정리

 

  # API 레퍼런스 : 요청 방식, 파라미터 유형, 필수 여부 등의 약속을 확인하고 용도에 맞게 코드에 작성해야 한다

    1. 요청(Request) : 특정 항목들을 일정 포맷에 따라 호출해야 한다. 

    2. 응답(Response) : API 요청에 대한 결과값

   

 

 

출처: https://tech.kakaoenterprise.com/127 [카카오엔터프라이즈 기술블로그 Tech&(테크앤):티스토리]