KA's Regalo

이전글 : 

2020/04/23 - [NETWORK] - REST 란?

▶ REST API 이란? 

 - REST기반으로 서비스 API를 구현한 것

▶ REST API 특징

 - REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.

 - REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.

 - 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.

▶ REST API 설계 기본 규칙

※ 참고

도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
스토어 : 클라이언트에서 관리하는 리소스 저장소

 - URI는 정보의 자원을 표현

  → resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
  → resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
  → resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
  → resource의 스토어 이름으로는 복수 명사를 사용해야 한다

 - 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현

  → URI에 HTTP Method가 들어가면 안된다.
  → URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
  → 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.

▶ REST API 설계 규칙

 - 

▶ 예시

▶ RESTful 이란? 

 - 레스트풀은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다.

 - 레스트풀은 REST를 REST답게 쓰기 위한 방법으로, REST 원리를 따르는 시스템을 RESTful이란 용어로 지칭된다.

▶ RESTful 목적

 - 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것

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

* 추후 추가 예정 

참고 :

https://www.a-mean-blog.com/ko/blog/%ED%86%A0%EB%A7%89%EA%B8%80/_/REST%EC%99%80-RESTful-API

https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html 

▶ REST란?

 - Representational State Transfer의 약자로 소프트웨어 프로그램 개발의 아키텍처의 한 형식.

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

HTTP 프로토콜을 이용하기 때문에 URL(route)를 통해 자원을 특정짓고 HTTP Verbs를 통해 할일(CRUD)을 지정합니다. 또한 JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적입니다.

▶ 장단점

 - 장점

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

 - 단점

1) 표준이 존재하지 않는다.
2) 사용할 수 있는 메서드가 4가지 밖에 없다.
2-1) HTTP Method 형태가 제한적이다.
3) 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.
4) 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다.
4-1) PUT, DELETE를 사용하지 못하는 점
4-2) pushState를 지원하지 않는 점

▶ 구성요소

 - 자원(Resource) : URI

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

 - 행위(Verb) : HTTP Method

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

 - 표현(Representation of Resource)

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

▶ 특징

 - Server/Client(서버/클라이언트 구조)

 - Stateless(무상태)

 - Cacheable(캐시 처리 가능)

 - Layered System(계층화)

 - Code-On-Demand(optional)

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

이어지는 글 :

2020/04/28 - [NETWORK] - REST API 란? RESTful 이란?

* 참고 :

https://www.a-mean-blog.com/ko/blog/%ED%86%A0%EB%A7%89%EA%B8%80/_/REST%EC%99%80-RESTful-API

https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html 

* 웹소켓이란? 

 - 서버와 클라이언트 간의 효율적인 양방향 통신 또는 데이터 전송이 가능하도록 하는 기술

 - Real time web application : 서버 or 클라이언트 데이터가 실시간으로 업데이트 되는 웹 어플리케이션

* 장점

 - 단순한 API

 - 하나의 HTTP 접속으로 메시지를 양방향 통신 (일정 시간이 지나면 HTTP연결은 자동으로 끊어짐)

 - XMLHttpRequest와 Server-Sent Events를 조합해서 양방향 통신을 구현하는 경우와 비교해 통신효율이 좋고, 설계나 구현도 간단

* 단점

 - 이전의 오래된 버전의 웹 브라우저에서는 지원하지 않음

 - 프로그램 구현에 보다 많은 복잡성 초래

※ XMLHttpRequest

 - 웹 브라우저와 웹 서버 간에 메소드가 데이터를 전송하는 객체 폼의 API

※ Server-Sent Events(SSE)

 - 클라이언트가 HTTP 연결을 통해 서버에서 자동 업데이트를 수신 할 수 있도록하는 서버 푸시 기술

참고 :

http://itnovice1.blogspot.com/2019/01/web-web-socket.html 

https://webclub.tistory.com/463

* 포트포워딩 이란?

- 포트 포워딩(port forwarding) 또는 포트 매핑(port mapping)은 컴퓨터 네트워크에서 패킷이 라우터나 방화벽과 같은 네트워크 게이트웨이를 가로지르는 동안 하나의 IP 주소와 포트 번호 결합의 통신 요청을 다른 곳으로 넘겨주는 네트워크 주소 변환(NAT)의 응용이다. 이 기법은 게이트웨이(외부망)의 반대쪽에 위치한 보호/내부망에 상주하는 호스트에 대한 서비스를 생성하기 위해 흔히 사용되며, 통신하는 목적지 IP 주소와 포트 번호를 내부 호스트에 다시 매핑함으로써 이루어진다. 

출처: 위키백과

다시말해 컴퓨터에게 "이쪽으로 가세요"라고 알려주는 방식입니다.

외부에서 가정에 있는 컴퓨터에 접근하기 위해서는 ip주소가 필요하지만, 집에 있는 모든 컴퓨터 마다 아이피가 존재하지 않습니다. 그래서 가정에서는 대부분 공유기로 인터넷을 사용합니다. 

이제 외부에서 내부의 컴퓨터에 접근하려 합니다. 내부에 여러대의 컴퓨터,노트북을 사용하는 경우 어떤 컴퓨터에 접근해야 하는지 공유기로는 모르기 때문에 포트로 해당 컴퓨터로 접근할수 있는 것이 포트 포워딩 입니다.

예를 들어 포트번호 2222로 들어왔으면 1번 컴퓨터로 연결되고, 포트번호 3390으로 들어왔으면 2번 컴퓨터로 연결합니다.

참고: https://steemit.com/kr/@d7795/5i6zc3