API? REST API?

재우·2023년 10월 27일

API Java REST API Restful Spring Springboot 스진초 프로그래머스

API 란?

Application Programming Interface(애플리케이션 프로그램 인터페이스)의 약자로, 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것.
즉, 소프트웨어 응용 프로그램에서 다른 소프트웨어 구성 요소 또는 서비스와 상호 작용하기 위한 인터페이스를 제공하는 프로그래밍 기술이다.

Application : 특정한 업무를 수행하기 위해 개발된 응용 소프트웨어

Programming :컴퓨터에 부여하는 명령을 만드는 작업. 수식이나 작업을 컴퓨터에 알맞도록 정리해서 순서를 정하고 컴퓨터 특유의 명령코드로 고쳐 쓰는 작업

Interface : 사물과 사물 사이 또는 사물과 인간 사이의 경계에서, 상호 간의 소통을 위해 만들어진 물리적 매개체나 통신 규칙

종합해보면 응용 소프트웨어를 만드는데 쓰는 매개체나 통신규칙! 아마 여러분이 아는 API의 정의와 엄청 크게 다르진 않을 것이다.

클라이언트와 서버 사이의 데이터 전송 통신을 위한 규칙이나 룰, 방법 이라고 생각하면 편할 것 같다.

API의 종류와 특징

API는 여러 가지 형태로 존재할 수 있다고 한다.

대표적으로 웹 API와 라이브러리 API가 있다.

웹 API

웹 API는 인터넷을 통해 다른 웹 서비스나 애플리케이션과 통신하기 위해 설계된 API로, 일반적으로 HTTP를 사용하여 데이터를 전송한다.
웹 API는 RESTful API, SOAP API 등 다양한 형태가 있으며, 이러한 API를 사용하여 데이터를 검색, 업로드, 업데이트 및 삭제할 수 있다.

우리가 현재 코드를 작성하면서 만드는 API가 웹 API에 해당한다.

라이브러리 API

라이브러리 API는 특정 프로그래밍 언어에서 사용되는 라이브러리나 프레임워크에서 제공되는 함수와 클래스 등을 사용하여 다른 소프트웨어 구성 요소와 상호 작용할 수 있도록 인터페이스를 제공한다.
이러한 API를 사용하여 다른 라이브러리나 프레임워크의 기능을 호출하거나 사용자 정의 함수와 클래스를 작성할 수 있다.

REST(Representational State Transfer)

REST 의 정의

자원을 이름으로 구분하여 해당 자원의 상태(정보)를 주고받는 모든 것을 의미
즉, 자원의 표현에 의한 상태 전달
- 자원의 표현
  - 자원 : 해당 소프트웨어가 관리하는 모든 것
  - 자원의 표현 : 그 자원을 표현하기 위한 이름
  - Ex) DB의 학생 정보가 자원일 때, 'students'를 자원의 표현으로 정함
- 상태(정보) 전달
  - 데이터가 요청되어지는 시점에 자원의 상태(정보)를 전달
  - JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적
기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍쳐 스타일
네트워크 상에서 Client 와 Server 사이의 통신 방식 중 하나

REST 의 개념

HTTP URI 를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT DELETE) 를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미
- 즉 REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미
- 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.
- CRUD Operation
  - Create: 생성(POST)
  - Read: 조회(GET)
  - Update: 수정(PUT)
  - Delete: 삭제(DELETE)
  - HEAD: header 정보 조회(HEAD)

REST API

REST API 란

API
- 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것
REST API의 정의
- REST 기반으로 서비스 API를 구현한 것
- OpenAPI(누구나 사용할 수 있는 공개된 API) 는 대부분 REST API를 제공

REST API의 설계 기본 규칙

URI는 자원의 정보를 표시해야 한다.
- resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다
- resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다
- resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다
- resource의 스토어 이름으로는 복수 명사를 사용해야 한다/
```
    GET /Member/1  -> GET /members/1
```
자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE) 로 표현한다.
- URI에 HTTML Method가 들어가면 안된다
```
GET /members/delete/1 -> DELETE /members/1
```
- URI에 행위에 대한 동사 표현이 들어가면 안된다(CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
```
GET /members/show/1 -> GET /members/1 
 GET /members/insert/2 -> POST /members/2
```
- 경로 부분 중 변하는 부분은 유일한 값으로 대체한다(즉 :id는 하나의 특정 resource를 나타내는 고유값이다)
  - Ex) student를 생성하는 route: POST/students
  - Ex) id=12인 student를 삭제하는 route: DELETE/students/12
REST API 설계 예시