|
| 1 | +# OpenWhisk 빌딩 블럭 - HTTP REST API 트리거 |
| 2 | + |
| 3 | +*다른 언어로 보기: [English](README.md).* |
| 4 | + |
| 5 | +IBM Bluemix의 Apache OpenWhisk로 REST API 매핑을 생성하십시오. 이 튜토리얼을 완료하기까지 5분 정도 소요됩니다. 이후 [_openwhisk-hands-on-demo_](https://github.com/search?q=topic%3Aopenwhisk-hands-on-demo+org%3AIBM&type=Repositories)로 태크된 것과 같은 복잡한 서버리스 애플리케이션으로 이동하십시오. |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +만약 OpenWhisk 프로그래밍 모델에 익숙하지 않은 경우, [액션, 트리거 그리고 |
| 10 | +룰에 대한 예제를 먼저 확인 하십시오](https://github.com/IBM/openwhisk-action-trigger-rule). |
| 11 | +[Bluemix 계정과 최신 버전의 OpenWhisk 명령행 도구가 필요합니다](https://github.com/IBM/openwhisk-action-trigger-rule/blob/master/docs/OPENWHISK.md). |
| 12 | + |
| 13 | +이 예제는 OpenWhisk `create-cat`과 `fetch-cat` 액션에 대응되는 HTTP `POST`와 `GET` 메소드에 대한 두 개의 REST 엔드포인트를 제공합니다. |
| 14 | + |
| 15 | +1. [OpenWhisk 액션 생성하기](#1-openwhisk-액션-생성하기) |
| 16 | +2. [REST endpoints 생성하기](#2-rest-endpoints-생성하기) |
| 17 | +3. [정리하기](#3-정리하기) |
| 18 | + |
| 19 | +# 1. OpenWhisk 액션 생성하기 |
| 20 | +## cat 엔티티를 생성하는 액션 만들기 |
| 21 | +`create-cat.js`이란 이름의 파일을 생성하십시오. 이 파일은 JavaSCript 함수로 작성된 OpenWhish 액션을 정의하게 됩니다. 이 함수는 요청된 매개 변수 (`name` 및 `color`)를 확인하며 cat에 대한 고유한 id를 리턴하거나 매개 변수가 없는 경우 오류를 리턴합니다. |
| 22 | +> **참고**: 이 예제는 단순화 된 것이며 백엔드 데이터 저장소와 연결되어 있지 않습니다. 좀 더 복잡한 예제는, [REST API 예제](https://github.com/IBM/openwhisk-serverless-apis)를 참고하시기 바랍니다. |
| 23 | + |
| 24 | +```javascript |
| 25 | +function main(params) { |
| 26 | + |
| 27 | + return new Promise(function(resolve, reject) { |
| 28 | + |
| 29 | + if (!params.name) { |
| 30 | + reject({ |
| 31 | + 'error': 'name parameter not set.' |
| 32 | + }); |
| 33 | + } else { |
| 34 | + resolve({ |
| 35 | + id: 1 |
| 36 | + }); |
| 37 | + } |
| 38 | + |
| 39 | + }); |
| 40 | + |
| 41 | +} |
| 42 | +``` |
| 43 | + |
| 44 | +## cat 엔티티를 리턴하는 액션 만들기 |
| 45 | +`fetch-cat.js`이란 이름의 파일을 생성하십시오. 이 파일은 JavaSCript 함수로 작성된 OpenWhish 액션을 정의하게 됩니다. 이 함수는 요청된 매개 변수 (`id`)를 확인하며 얼룩 고양이 Tahoma를 리턴합니다. |
| 46 | +> **참고**: 다시 말해, 단순화된 데모용으로 백엔드 데이터 저장소 연결보다 Tahoma 고양이를 항상 리턴합니다. |
| 47 | + |
| 48 | +```javascript |
| 49 | +function main(params) { |
| 50 | + |
| 51 | + return new Promise(function(resolve, reject) { |
| 52 | + |
| 53 | + if (!params.id) { |
| 54 | + reject({ |
| 55 | + 'error': 'id parameter not set.' |
| 56 | + }); |
| 57 | + } else { |
| 58 | + resolve({ |
| 59 | + id: params.id, |
| 60 | + name: 'Tahoma', |
| 61 | + color: 'Tabby' |
| 62 | + }); |
| 63 | + } |
| 64 | + |
| 65 | + }); |
| 66 | + |
| 67 | +} |
| 68 | +``` |
| 69 | + |
| 70 | +## 액션 업로드하기 |
| 71 | +다음 단계에서는 방금 생성한 JavaScript 함수로 부터 OpenWhisk 액션을 생성하게 됩니다. 이들 액션에 `--web true`라는 플래그를 추가하여 "웹 액션"으로서 주석을 추가합니다. 이는 나중에 REST 엔드 포인트를 추가할 때 필요합니다. |
| 72 | +```bash |
| 73 | +wsk action create create-cat create-cat.js --web true |
| 74 | +wsk action create fetch-cat fetch-cat.js --web true |
| 75 | +``` |
| 76 | + |
| 77 | +## 액션에 대해 단위 테스트하기 |
| 78 | +OpenWhisk 액션은 명백하게 호출되거나 이벤트에 대응하는 무상태 코드 스니펫입니다. 지금은, 명백하게 호출하는 방법으로 액션을 테스트 하게 됩니다. 나중에는, HTTP 요청에 대응하여 액션을 트리거 하게 됩니다. 아래 코드를 이용하여 액션을 호출하고 `--param` 명령줄 인수를 사용하여 매개 변수를 전달하십시오. |
| 79 | + |
| 80 | +```bash |
| 81 | +wsk action invoke \ |
| 82 | + --blocking \ |
| 83 | + --param name Tahoma \ |
| 84 | + --param color Tabby \ |
| 85 | + create-cat |
| 86 | + |
| 87 | +wsk action invoke \ |
| 88 | + --blocking \ |
| 89 | + --param id 1 \ |
| 90 | + fetch-cat |
| 91 | +``` |
| 92 | + |
| 93 | +> **참고**: 오류 메시지가 보이는 경우 아래 [문제 해결](#문제-해결) 영역을 참고 하십시오. |
| 94 | + |
| 95 | +# 2. REST endpoints 생성하기 |
| 96 | +## `/v1/cat` 엔드포인트에 대한 POST와 GET REST 매핑 생성하기 |
| 97 | +지금까지 OpenWhisk 액션을 생성했고, 이제 Bluemix API 게이트웨어를 통해 OpenWhisk 액션을 노출하게 됩니다. 이를 위해 이 명령을 이용합니다: `wsk api create $BASE_PATH $API_PATH $API_VERB $ACTION ` |
| 98 | + |
| 99 | +이 기능은 [Bluemix Native API Management](https://console.ng.bluemix.net/docs/openwhisk/openwhisk_apigateway.html#openwhisk_apigateway)의 일부이며 현재 보안, 속도 제한 등과 같은 매우 강력한 API 관리 기능을 제공합니다. 비록 지금은 단지 CLI를 사용하여 public REST endpoint로 액션을 노출하고 있습니다. |
| 100 | + |
| 101 | +```bash |
| 102 | +# 명령과 함께 신임 정보를 보내거나 대화식으로 제공합니다 |
| 103 | +wsk bluemix login --user $YOUR_BLUEMIX_USERNAME --password $YOUR_BLUEMIX_PASSWORD |
| 104 | + |
| 105 | +# POST로 노출 /v1/cat {"name": "Tahoma", "color": "Tabby"} |
| 106 | +wsk api create -n "Cats API" /v1 /cat post create-cat |
| 107 | + |
| 108 | +# 노출 /v1/cat?id=1 |
| 109 | +wsk api create /v1 /cat get fetch-cat |
| 110 | +``` |
| 111 | +두 가지 모두의 경우, CLI는 API 사용을 위해 URL을 출력할 것입니다. 다음 영역을 위해 모든 정보를 기록해 두십시오. |
| 112 | + |
| 113 | +## `curl` HTTP 요청으로 테스트 |
| 114 | +앞서 명령으로 생성된 API URL을 가져옵니다. 액션 테스트를 위해 `curl`을 사용하여 http POST와 GET 요청을 보냅니다. 필요로하는 매개 변수 전달을 위해 POST에 대해서는 요청의 body에, GET에 대해서는 경로에 전달되는 것을 기억하십시오. OpenWhisk는 이와 같은 매개변수를 액션에 자동으로 전달합니다. |
| 115 | + |
| 116 | +```bash |
| 117 | +# POST /v1/cat {"name": "Tahoma", "color": "Tabby"} |
| 118 | +curl -X POST -H 'Content-Type: application/json' -d '{"name":"Tahoma","color":"Tabby"}' $THE_URL_FROM_ABOVE |
| 119 | + |
| 120 | +# GET /v1/cat?id=1 |
| 121 | +curl $THE_URL_FROM_ABOVE?id=1 |
| 122 | +``` |
| 123 | + |
| 124 | +# 3. 정리하기 |
| 125 | +## 모든 API 매핑을 제거하고 액션을 삭제하십시오 |
| 126 | + |
| 127 | +```bash |
| 128 | +# 모든 매핑을 제거하는 API 베이스 삭제 |
| 129 | +wsk api delete /v1 |
| 130 | + |
| 131 | +# 액션 삭제 |
| 132 | +wsk action delete create-cat |
| 133 | +wsk action delete fetch-cat |
| 134 | +``` |
| 135 | + |
| 136 | +# 문제 해결 |
| 137 | +가장 먼제 OpenWhisk 활성화 로그에서 오류를 확인 하십시오. 명령창에서 `wsk activation poll`을 이용하여 로그 메시지를 확인하거나 [Bluemix의 모니터링 콘솔](https://console.ng.bluemix.net/openwhisk/dashboard)에서 시각적으로 상세정보를 확인해 보십시오. |
| 138 | + |
| 139 | +오류가 즉각적으로 분명하지 않다면, [최신 버젼의 `wsk` CLI](https://console.ng.bluemix.net/openwhisk/learn/cli)가 설치되어 있는지 확인하십시오. 만약 이전 것이라면 다운로드하고 업데이트 하십시오. |
| 140 | +```bash |
| 141 | +wsk property get --cliversion |
| 142 | +``` |
| 143 | + |
| 144 | +# 라이센스 |
| 145 | +[Apache 2.0](LICENSE.txt) |
0 commit comments