API
api는 서버와 데이터베이스에 대한 출입구 역할을 한다. 애플리케이션과 기기가 원활히 통신할 수 있도록 하고, 모든 접속을 표준화 한다. api를 사용하면 구현 바식을 알지못해도 제품 또는 서비스가 서로 커뮤니케이션 할 수 있고, 애플리케이션 개발을 간소화하여 시간과 비용을 절약할 수 있다.
REST
REST 구조 스타일에 적합한 Web API를 REST API라고 한다.
REST는 SOAP이 서비스 지향 구조인 것과 달리 자원지향구조(ROA: Resource Oriented Architecture)로 웹 사이트의 컨텐츠(Text, 이미지, 동영상), DB의 내용 등을 전부 하나의 자원으로 파악하여 각 자원의 고유한 URI(Uniform Resource Identifier)를 부여하고, 해당 자원에 대한 CRUD(Create, Read, Update, Delete) 작업을 HTTP의 기본 명령어인 POST, GET, PUT, DELETE를 통해서 처리한다.
탄생
2000년도에 로이 필딩 (Roy Fielding)의 박사학위 논문에서 최초로 소개되었다. 로이 필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시 웹(HTTP) 설계의 우수성에 비해 제대로 사용되지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다.
특징
HTTP 웹 표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있다.
Uniform Interface
URI로 지정한 리소스에 대한 조장을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일
Stateless
무상태성. 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. API 서버는 들어오는 요청만을 단순하게 처리하면 되기 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다
Cacheable
Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능
Self-descriptiveness(자체표현구조)
REST API 메시지만 보고도 작동을 쉽게 이해할 수 있다.
Client-Server 구조
REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어든다.
계층형 구조
다중 계층으로 구성할 수 있어 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고, proxy, gateway같은 네트워크 기반의 중간매체를 사용할 수 있다
REST API 설계
- URI는 정보의 자원을 표현해야 한다
- 자원에 대한 행위는 HTTP Method(GET,POST,PUT,DELETE)로 표현한다
URI 설계
- 슬래시(/)는 계층 관계를 나타내는 데 사용한다
- URI 마지막 문자로 /를 포함하지 않는다
- 하이픈(-)은 가독성을 높일 때 사용
- 밑줄(_)은 사용하지 않는다
- 소문자
- 파일확장자는 URI에 포함시키지 않는다
- 리소스 간에 연관기 있을 때 표현 방법
/리소스명/리소스 ID/관계가 있는 다른 리소스명
ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)HTTP 응답 상태코드
| 상태코드 | 의미 |
|---|---|
| 200 | 클라이언트의 요청을 정상적으로 수행함 |
| 201 | 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST 이용시) |
| 400 | 클라이언트의 요청이 부적절 할 경우 |
| 401 | 클라이언트가 인증되지 않은 상태(로그인)에서 보호된 리소스를 요청했을 때 |
| 403 | 유저 인증과 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 |
| 301 | 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답코드 |
| 500 | 서버에 문제가 있을 경우 사용 |
📑 reference
