가비아 API 지침서

효율적인 서비스 구축 및 관리를 위한 API
활용 지침서를 안내해 드립니다.

• 1

  개발자도 비즈니스를 이해해야 한다!

  API를 이용하기에 앞서, 비즈니스 관점에서 어떠한 정보를 수행할지, 어떻게 적용할 것인지 고민되어야 합니다.
  문자서비스에서 가장 중요한 것은 ‘누가 누구에게 언제 어떤 내용으로 발송할 것인가’ 입니다.
  이러한 데이터를 어떻게 접목하느냐에 따라 서비스의 퀄리티가 달라집니다.
  효과적, 효율적인 데이터 교환을 위해, 비즈니스에 맞는 플로우를 설계해보세요.

• 2

  RESTful하게 설계해보자!

  REST API를 설계하기 위해서는 2가지의 구성 요소가 필요합니다.
  URI는 리소스를 표현하고, HTTP Method는 행위를 정의합니다.
  URI는 통합 리소스 식별자로 리소스를 표현하는 데 집중되어야 합니다.
  이는 동사보다는 명사를 이용하는 것이 직관적입니다.
  행위를 표현하는 것은 HTTP Method (GET, POST, PUT, DELETE)이며
  Method의 4가지 행위에 대한 역할을 정의하여 설계할 수 있습니다.

  Method	CRUD(역할)
  GET	리소스를 조회하고 정보를 가져온다
  POST	리소스를 생성(추가)한다
  PUT	리소스를 수정한다
  DELETE	리소스를 삭제한다

  (발송 결과 예시) [GET] /api/user/info
  

  TIP. 리소스는 대소문자를 구분하므로, 섞어서 사용할 경우 혼란을 일으킬 수도 있습니다.
  소문자를 이용하여 개발해보세요.

• 3

  HTTP 상태 코드를 잘 활용하자!

  HTTP 요청이 성공 혹은 실패였는지, 완료된 상태 값을 적절히 활용해야 합니다.
  성공의 의미는 HTTP Method에 따라서도 달라지므로 정확하게 이를 파악하는 것이 중요합니다.
  상태 코드의 구분이 명확하다면, 장애 발생 시, 빠른 대응 및 처리를 할 수 있으므로
  서비스의 퀄리티에도 직접적인 연관이 있습니다.
  상태 코드는 성공(200번대), 실패(400번대), 서버 에러 (500번대) 여부를 확인하고,
  상세 코드를 통해 에러 및 버그에 대해 대응할 수 있습니다.

  예시 - 상태코드

  200 Success 요청이 성공적으로 완료되었습니다.
  400 Fail 요청이 실패되었습니다.
  500 server error 서버에 오류가 발생했습니다.

  예시 - 상세코드

  [code] => invalid_phone_number'
  [message] => 허용하는 수신 번호 형식이 아닙니다