API Gateway를 이용한 Rest API 구축하기

학습내용

API Gateway
REST API 설계
API Gateway를 통한 Device Shadow 액세스 하기

1. API Gateway란?

API Gateway는 개발자가 손쉽게 API를 생성, 게시, 유지관리, 모니터링할 수 있게 해주는 완전 관리형 서비스입니다.
- API Gateway는 트래픽 관리, 권한 부여 및 액세스 제어, 모니터링 및 API 버전 관리 등 최대 수십만 개의 동시 API 호출을 수신 및 처리하는 데 관계된 모든 작업을 처리합니다.
API Gateway을 이용하여 할 수 있는 일은?
- API 개발자는 AWS 또는 다른 웹 서비스뿐 아니라 AWS 클라우드에 저장된 데이터에 액세스하는 API를 생성할 수 있습니다.
- API 개발자는 자체 클라이언트 애플리케이션(앱)에서 사용할 API를 만들 수 있습니다. 또는 타사 앱 개발자가 API를 사용하도록 제공할 수도 있습니다.
- 앱 개발자는 API Gateway에서 API 개발자가 생성한 API를 호출하여 AWS 서비스를 호출하기에 효과적인 애플리케이션을 구축합니다.
API Gateway을 통해 만들 수 있는 API 종류
- REST API
  - 상태가 없는 클라이언트-서버 통신을 지원하는 REST 프로토콜 준수
  - 짧은 기간의 통신
  - HTTP 메소드 (Get, Post, Put, Delete, 등)
- WebSocket API
  - 클라이언트와 서버 간에 상태를 저장하는 전이중 통신을 지원하는 WebSocket 프로토콜 준수
  - 긴 기간의 통신
  - 양방향 통신 채널

[AWS 실습] Amazon API Gateway에서 Lambda 통합으로 REST API 생성

2. REST API 설계

REST API는 웹 상의 어떤 자원에 대한 처리를 위해서 다음 3가지 구성요소로 정의된다.
- 리소스 (Resource)
  - 서버는 Unique한 ID를 가지는 리소스를 가지고 있으며, 클라이언트는 이러한 리소스에 요청을 보냅니다. 이러한 리소스는 URI에 해당합니다.
- 메소드 (Method)
  - 서버에 요청을 보내기 위한 방식으로 GET, POST, PUT, DELETE가 있습니다. CRUD 연산 중에서 처리를 위한 연산에 맞는 메소드를 사용하여 서버에 요청을 보내야 합니다.
- 자원의 표현 (Representation of Resource)
  - 클라이언트와 서버가 데이터를 주고받는 형태로 json, xml, text, rss 등이 있습니다. 최근에는 Key, Value를 활용하는 json을 주로 사용합니다.
REST API 설계 기본 규칙
- 리소스는 동사보다는 명사를, 대문자보다는 소문자를 사용
- 리소스의 도큐먼트 이름으로는 단수명사를 사용
- 리소스의 컬렉션 이름으로 복수명사를 사용
- 리소스에 대한 행위는 HTTP Method (GET, PUT, POST, DELETE)로 표현한다.

2.1 디바이스 목록 조회

요청
```
GET /devices
```

응답모델

{
    "things": [ 
         { 
            "thingName": "string",
            "thingArn": "string"
         }, 
         ...
       ]
}

2,2 디바이스 상태 조회

요청
```
GET /devices/{deviceId}
```

응답 모델

GetThingShadow의 응답 상태 문서

{
    "state": {
        "desired": {
            "attribute1": integer2,
            "attribute2": "string2",
            ...
            "attributeN": boolean2
        },
        "reported": {
            "attribute1": integer1,
            "attribute2": "string1",
            ...
            "attributeN": boolean1
        },
        "delta": {
            "attribute3": integerX,
            "attribute5": "stringY"
        }
    },
    "metadata": {
        "desired": {
            "attribute1": {
                "timestamp": timestamp
            },
            "attribute2": {
                "timestamp": timestamp
            },
            ...
            "attributeN": {
                "timestamp": timestamp
            }
        },
        "reported": {
            "attribute1": {
                "timestamp": timestamp
            },
            "attribute2": {
                "timestamp": timestamp
            },
            ...
            "attributeN": {
                "timestamp": timestamp
            }
        }
    },
    "timestamp": timestamp,
    "clientToken": "token",
    "version": version
}

2.3 디바이스 상태 변경

요청

PUT /devices/{deviceID}

body

{ 
    "tags" : [
        {
            "attrName": "temperature",
            "attrValue": "27.0"
        },
        {
            "attrName": "LED",
            "attrValue": "OFF"
        }
    ]
}

응답모델
- UpdateThingShadow의 응답 상태 문서

2.4 디바이스 로그 조회

요청

GET /devices/{deviceId}/log?from=2019-11-20 11:12:10&to=2019-12-1 12:00:00

응답모델

{
    "data":[
        {
            "time":timestamp,
            "attribute1": integer3,
            "attribute2": "string3",
                ...
        },
        ...
    ]
}

3. API Gateway를 통한 Device Shadow 액세스 하기

AWS IoT 플랫폼에서는 원하는 프로그래밍 언어를 기반으로 AWS SDK를 사용하여 디바이스 섀도에 액세스 할 수 있습니다. 이 장에서는 Java용 AWS SDK를 사용하여 Device Shadow를 액세스하는 Lambda 함수를 정의하고, 이 Lambda 함수를 API Gateway와 통합하여 2절에서 정의한 REST API를 구축하는 방법을 설명합니다.

AWS SDK for Java를 프로젝트에서 사용하려면 pom.xml 파일에서 종속성으로 필요한 개별 모듈을 선언해야 합니다. 디바이스 섀도에 액세스 하기 위해서는 aws-java-sdk-iot를 종속성으로 선언해야 합니다.