API

• Applicaion Programming Interface
  • Interface : 기계와 인간간의 소통 창구
  • 소프트웨어와 소프트웨어 간 지정된 형식으로 요청, 명령을 받을 수 있는 수단
• 정보들이 주고받아지는 데 있어서 개발자들 사이에서 널리 쓰이는 일종의 형식

RESTful API

• API 시스템을 구현하기 위한 아키텍처 중에 가장 널리 사용되는 형식
• Graphql, GRPC, REST ... etc

Representational State Transfer

• 웹 상에서 사용되는 여러 리소스를 HTTP URI로 표현하고 그 리소스에 대한 행위를 HTTP Method로 정의하는 방식.

RESTful API의 장단점

장점

• API 자체만으로도 API 의 목적이 쉽게 이해 된다.
  • GET/users/1
  • 1번 유저 호출

단점

• 표준규약이 없어 비효율적이거나 비생산적인 패턴으로 작성되는 경우가 많다.

기본 배경 지식

• URI (Uniform Resource Identifier)
  • 해당 사이트의 특정 자원의 위치를 나타내는 유일한 주소
  • http://finance.naver.com/login
  • /login 부분이 URI
• HTTP Method
  • HTTP request가 의도하는 action을 정의한 것
• Payload
  • HTTP request에서 server로 보내는 데이터 (body)

설계 규칙

• URI의 / 구분자를 사용해 자원의 계층 관계를 나타낸다.
• URI가 길어지는 경우 -를 사용하여 가독성을 높인다.
• _는 사용하지 않는다. ( 가독성을 위하여)
• URI 경로에는 대문자 사용을 피하도록 규정
• 동사 금지, 명사 사용