RESTful API

younghyun·2022년 3월 4일

API

소프트웨어가 다른 소프트웨어로부터 지정된 형식으로 요청 받을 수 있는 수단
어떠한 응용프로그램에서 데이터를 주고 받기 위한 방법을 의미. 어떤 특정 사이트에서 특정 데이터를 공유할 경우 어떠한 방식으로 정보를 요청해야 하는지, 그리고 어떠한 데이터를 제공 받을 수 있을지에 대한 규격
프로그램을 만드는데 필요한 어떤 기능을 직접 구현하지 않고 API 제공자들이 제공하는 데이터와 모듈 등을 갖다쓸 수 있게 해주는 게 API와 API 문서
즉, 프로그램 간 다리

Ex)
흔히 API를 레스토랑에 빗대어 표현. 손님(내가 만드는 프로그램)이 자리에 앉아 웨이터(API)에게 주문. 그럼 웨이터는 내 주문 내역을 주방(API 제공자. 기상청, 공공포탈 등)에 갖다줌. 주방에서 요리를 해 웨이터에게 주면 웨이터가 다시 나에게 음식을 가져다줌. 웨이터가 손님의 주문을 주방으로 전달하는 매개체 역할을 하는 것.
여기서 손님은 주방에서 무슨 일이 일어나는지 잘 모름. 대개는 관심도 없으며 관심을 가질 필요도 딱히 없음. 이것이 API의 장점. 내가 가져다쓰려는 API의 기능을 어떻게 구현하는지 몰라도 되고 난 그저 API가 갖다주는 걸 사용만 하면 된다(식사한다)는 것. 시간과 노력을 동시에 아낄 수 있음. 이처럼 API는 처음부터 개발하거나 유지 보수할 필요가 없는 외부 데이터와 기능에 접속할 수 있게 해줌.

내가 동대문에서 옷을 떼다 온라인으로 팔려고 함. 그런데 내가 결제 시스템을 알 필요가 있을까? 물론 결제 시스템을 직접 만들 수도 있겠지만 시간도 오래 걸리고 정작 옷을 파는 본업에 집중하지 못할 수도 있음. 게다가 내가 만든 결제 시스템에 오류라도 난다면 당장 고쳐야 함. 점점 옷을 팔아 매출을 내는 사업가라는 일과는 멀어지고 개발자화되어가는 모습. 이런 상황이라면 결제 시스템 API를 제공자에게서 받아서 내 사이트에 넣는 것이 훨씬 현명한 일

종류

public : 개방형 API로, 모두에게 공개.
private : private API는 내부 API로, 회사 개발자가 자체 제품과 서비스를 개선하기 위해 내부적으로 발행. 따라서 제 3자에게 노출되지 않음.
partner: partner API는 기업이 데이터 공유에 동의하는 특정인들만 사용할 수 있음. 비즈니스 관계에서 사용되는 편이며, 종종 파트너 회사 간에 소프트웨어를 통합하기 위해 사용.
복합 : 복합 API는 두 개 이상의 서로 다른 API를 결합하여 복잡한 시스템 요구 사항이나 동작을 처리.

특징

API는 서버와 데이터베이스에 대한 출입구 역할.
데이터베이스에는 소중한 정보들이 저장됨. 모든 사람들이 이 데이터베이스에 접근할 수 있으면 안 됨. API는 이를 방지하기 위해 여러분이 가진 서버와 데이터베이스에 대한 출입구 역할을 하며, 허용된 사람들에게만 접근성을 부여함.
API는 애플리케이션과 기기가 원활하게 통신할 수 있도록 함.
여기서 애플리케이션이란 우리가 흔히 알고 있는 스마트폰 어플이나 프로그램. API는 애플리케이션과 기기가 데이터를 원활히 주고받을 수 있도록 돕는 역할.
API는 모든 접속을 표준화.
API는 모든 접속을 표준화하기 때문에 기계/운영체제 등과 상관없이 누구나 동일한 액세스를 얻을 수 있음. 쉽게 말해, API는 범용 플러그처럼 작동한다고 볼 수 있음.

Interface

기계 간의 장치끼리 정보를 교환하기 위한 수단이나, 방법.
예를 들어서 우리가 집에서 TV를 켜기 위해서 리모콘을 들고 TV에 리모콘 전원 버튼을 누름으로써 TV가 켜지게 됨. 즉, 사전에 TV와 통신을 하기 위해서 리모콘에서는 TV에 정의된 규격에 의해 어떤 신호를 보낼 수 있도록 만들어진 장치이며, 이러한 신호를 서로 주고 받기 위한 방법을 인터페이스라고 하는 것.

API 동작 방식

1.SOAP API
이 API는 단순 객체 접근 프로토콜을 사용. 클라이언트와 서버는 XML을 사용하여 메시지를 교환. 과거에 더 많이 사용되었으며 유연성이 떨어지는 API.
2. RPC API
이 API를 원격 프로시저 호출. 클라이언트가 서버에서 함수나 프로시저를 완료하면 서버가 출력을 클라이언트로 다시 전송.
3. Websocket API
Websocket API는 JSON 객체를 사용하여 데이터를 전달하는 또 다른 최신 웹 API 개발. WebSocket API는 클라이언트 앱과 서버 간의 양방향 통신을 지원. 서버가 연결된 클라이언트에 콜백 메시지를 전송할 수 있어 REST API보다 효율적.
4. REST API
오늘날 웹에서 볼 수 있는 가장 많이 사용되고 유연한 API. 클라이언트가 서버에 요청을 데이터로 전송. 서버가 이 클라이언트 입력을 사용하여 내부 함수를 시작하고 출력 데이터를 다시 클라이언트에 반환.

REST(Representational State Transfer)

웹에 존재하는 모든 자원(resorce, ex. 이미지, 동영상, 데이터)에 고유한 URI를 부여하여 자원에 대한 주소를 지정하는 방법론, 또는 규칙
자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것

자원(resource)의 표현(representation)
- 자원 : 해당 소프트웨어가 관리하는 모든 것예) 문서, 그림, 데이터, 해당 소프트웨어 자체 등
- 자원의 표현 : 그 자원을 표현하기 위한 이름예) DB의 학생 정보가 자원일 때, ‘students’를 자원의 표현으로 정함.
상태(정보) 전달
데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달.
JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적.
월드 와이드 웹 (WWW)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식.
- REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일.
- REST는 네트워크상에서 Client와 Server 사이의 통신 방식 중 하나

즉,
1. HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고,
2. HTTP Method(POST, GET, PUT, DELETE)를 통해
3. 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미.

REST 구성 요소
1. 자원(Resource) : HTTP URI

모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재.
자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI.
Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청.

자원에 대한 행위(Verb) : HTTP Method

HTTP 프로토콜의 Method를 사용.
HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공

자원에 대한 행위의 내용 (Representations of Resource) : HTTP Message Pay Load

Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보냄.
REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있음.
JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적

REST의 특징
1. Server-Client(서버-클라이언트 구조)

자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client.
- REST Server : API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
- Client : 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임짐.
서로간 의존성이 줄어듦.

Stateless(무상태)

HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 가짐.
Client의 context를 Server에 저장하지 않음.
- 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해짐.
Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리.
- 각 API 서버는 Client의 요청만을 단순 처리.
- 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안됨.
- 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용.
- Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아짐.

Cacheable(캐시 처리 가능)

웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있음.
- 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있음.
- HTTP 프로토콜 표준에서 사용하는 Last-Modified 태스나 E-Tag를 이용하면 캐싱 구현이 가능.
대량의 요청을 효율적으로 처리하기 위해 캐시가 요구됨.
캐시 사용을 통해 응답시간이 빨리지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있음.

Layered System(계층화)

Client는 REST API Server만 호출.
REST Server는 다중 계층으로 구성될 수 있음.
- API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있음.
- 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있음.
PROXY, 게이트웨어 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

Uniform Interface(인터페이스 일관성)

URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행.
HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능.
- 특정 언어나 기술에 종속되지 않음.

Code-On-Demand(optional)

Server로부터 스크립트를 받아서 Client에서 실행.
반드시 충족할 필요는 없음.

REST의 장단점
장점
1. HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없음.
2. HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해 줌.
3. HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능.
4. Hypermedia API의 기본을 충실히 지키면서 범용성을 보장.
5. REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있음.
6. 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화.
7. 서버와 클라이언트의 역할을 명확하게 분리.

단점
1. 표준이 자체가 존재하지 않아 정의가 필요.
2. 사용할 수 있는 메소드가 4가지밖에 없음.
3. HTTP Method 형태가 제한적.
4. 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구됨.
5. 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많음.(익스폴로어)

REST가 필요한 이유

‘애플리케이션 분리 및 통합’
‘다양한 클라이언트의 등장’
최근의 서버 프로그램은 다양한 브라우저와 안드로이폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 함.
이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 됨.

RESTful API

REST 기반으로 서비스 API를 구현한 것
최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공.

구조
- URI
  - 자원을 구조와 함께 나타내는 이런 형태 구분자
  - 해당 사이트 특정 자원 위치를 나타내는 유일한 주소
  - https://finance.naver.com/login
  - https://finance.naver.com/news
- HTTP Method
  - HTTP request가 의도하는 action 정의
- Payload
  - HTTP request에서 server로 보내는 데이터 ( body )
장점
- self-descriptiveness, Restful API는 그 자체만으로도 API 목적 쉽게 이해됨.
단점
- 표준 규약이 없어, 안티패턴으로 작성되는 경우가 흔하다
특징
- 각 요청이 어떤 동작이나 정보를 위한 것인지를, 요청의 모습 자체로 추론 가능
- 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있음.
- REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있음.
- 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있음.

메서드 종류

서버에 REST API 로 요청을 보낼 때는 HTTP 란 규약에 따라 신호를 전송함. HTTP로 요청을 보낼 때도 여러 메소드가 있음.

POST(데이터 쓰고, 읽고, 수정, 삭제까지 다할 수 있음), PUT, PATCH에는 body란 주머니가 있어서 정보들을 GET, DELETE 보다 많이 그리고 비교적 안전하게 감춰서 실어보낼 수 있음.

GET, POST 메서드 로 생성, 조회, 삭제 등이 모두 가능하지만 RestAPI를 만들 때는 누구든지 각 요청 의도를 쉽게 파악할 수 있도록 GET, POST, DELETE 등으로 구분합니다.

GET : 데이터 조회, QueryString를 이용하여 URL에 서버에 보내줄 데이터값이 노출 되는 방식
POST : 데이터 추가, id는 보통 정보 추가되면서 생성됨.(명기할 필요없음.)
서버에 보내줄 데이터를 HTTP Body영역에 넣어서 보내는 방식
POST는 GET에 비해 데이터가 외부에 노출 되지 않아 보안에 조금 더 좋다고 할 수 있으나 사실 POST도 데이터는 개발자도구등을 이용하여 전부 확인은 가능합니다.
put : 데이터 업데이트(정보를 통째로 변경)
delete : 데이터 삭제
patch : 대아토 아류 뵨굥
POST로 CRUD를 할 수는 있지만, 동작까지 명기해야함. 정석적인 메서드 사용방법에 비해 깔끔하지 않음. 이런 것들을 지양하기 위한 REST 규칙중 하나로, URI는 동사가 아닌 명사들로 이뤄져야 함.

REST 규칙

url 은 page 기준이 아닌 resource 기준으로 작성.
```
[GET] http://127.0.0.1:8000/product/main_page_product
```
메인 페이지에 표출 되어야 할 정보가 무엇인지 판별하여 url을 정함
한 번에 여러 종류의 정보를 표출해야 한다면, 프론트엔드 개발자와 협의하여 REST에 맞춰 두가지 이상의 endpoint를 동시에 호출
우리 웹 서비스 메인페이지에 여름특가 이벤트 + 사용자의 내 상세 정보
```
[GET] http://127.0.0.1:8000/store/find_store
```
동사(find)를 사용하지 않음. 명사 사용 ( 단수일수도 복수일수도 있음 )
```
[POST] [http://127.0.0.1:8000/product/add_first_item_information]
```

자원을 추가(add)할 때는 ~/post 만으로 충분

[GET] [http://127.0.0.1:8000/store](http://127.0.0.1:8000/store/search_store)?name='강남'

검색 기능은 자원의 정보를 호출하는 기능이므로 [GET] method를 사용
검색 키워드는 body를 통해 전달하지 않고, query string을 활용.
URI에 HTTP 메소드가 포함되서는 안된다
resource사이 연관 관계가 있는 경우
- /리소스/고유ID/관계 있는 리소스
  EX) GET/users/{user_id}/profile
파일의 경우 payload포맷을 나타내기 위한 파일 확장자를 URI에 포함시키지 않음.
EX) GET user/1/profile-photo.jpg(X)
EX) GET user/1/profile-photo ( 이때, payload 포맷은 headers에 accept사용 )
URI는 /구분자를 사용해 자원의 계층 관계를 나타냄
URI 마지막 문자로 /를 포함하지 않음.
- URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 함.
- REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않음.
- Ex) http://restapi.example.com/houses/apartments/ (X)
  https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html
불가피하게 URI가 길어지는 경우 0을 사용해 가독성 높임. _는 사용하지 않음.
- 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않음.
하이픈(-)은 URI 가독성 높이는데 사용
- 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높임.
URI경로에는 대문자 사용을 피함.

RESTful

일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어. ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있음.

RESTful의 목적

이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없음.

RESTful 하지 못한 경우

Ex1) CRUD 기능을 모두 POST로만 처리하는 API
Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

Path Parameter & Query parameter

Path Parameter

간단한 수정을 위해 필터링해서 불러올 수 있음

Query parameter

웹 페이지의 url 주소를 자세히 보면 종종 ? 가 포함되어 있는 것을 보셨을 것입니다. 이 물음표는 단순한 문자열이 아님. 특정한 기능을 수행하고 있음. 물음표 뒤에는 늘 key=value 형식의 문자열이 따라옴. 이를 Query parameter 라고 부름.
주로 데이터를 조건으로 거르거나(filtering), 특정 방식으로 정렬하거나(sorting), 검색(searching)하고자 하는 경우에 활용