TIL) RESTful API

Jiwon Lee·2022년 8월 17일
0

TIL

목록 보기
14/19

API란?

  • API란, 'Application Programming Interface'의 줄임말로, 컴퓨터나 컴퓨터 프로그램 사이의 연결이다. 일종의 소프트웨어 인터페이스이며, 다른 종류의 소프트웨어에 서비스를 제공한다.
    쉽게 말해, API는 프로그램들이 서로 상호작용하는 것을 도와주는 매개체라고 볼 수 있다.

REST API란?

  • REST는'Representational State Transfer'의 줄임말로, 상태(state)를 전달(transfer)하는 것을 나타내는(representation) 방법.
  • 즉, '자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 것'을 의미한다. 클라이언트가 서버 데이터에 액세스 하는 데에 사용할 수 있는 GET, PUT, DELETE등의 함수 집합을 정의한다.
  • API 시스템을 구현하기 위하여 오늘날 웹에서 볼 수 있는 가장 많이 사용되고 유연한 API이다.
  • 클라이언트가 서버에 요청을 데이터로 전송하면 서버가 이 클라이언트의 입력을 사용하여 내부 함수를 시작하게 되고, 출력 데이터를 다시 클라이언트에게 반환한다.

RESTful API의 장단점

  • 장 : RESTful API는 그 자체만으로도 API의 목적이 쉽게 이해가 간다.
  • 단 : 표준 규약이 없어, 안티패턴으로 작성이 되는 경우가 흔하다.
    안티패턴은 실제 많이 사용되는 패턴이지만 비효율적이거나 비생산적인 패턴을 의미함

REST API 설계 규칙

  • 엔드포인트는 동사가 아닌 명사로 작성하는 것이 일반적.
  • 리소스에 대한 행위를 HTTP 메소드인 GET, POST, PUT, PATCH, DELETE로 표현한다.
  • 리소스 사이에 연관 관계가 있는 경우, 사이에 '/'를 넣어 사용한다.
  • URI가 다소 길어졌다 생각되면 '_'언더바가 아닌 '-'하이픈을 넣어 가독성을 높인다.

0개의 댓글