Function Compute:API Gateway トリガー

1. API Gateway コンソール にログインします。左側のナビゲーションウィンドウで、[API の管理] > [バックエンドサービス] を選択します。上部のナビゲーションバーで、リージョンを選択します。次に、右上隅にある [バックエンドサービスの作成] をクリックし、次の図に示すようにパラメーターを構成して、[確認] をクリックします。

   

2. [バックエンドサービス] ページで、作成したバックエンドサービスをクリックします。[バックエンドサービスの定義] ページで、[本番環境] タブをクリックします。[基本情報] セクションで、[作成] をクリックします。ステップ 1 で作成したイベント関数を選択し、[公開] をクリックします。

   

3. API グループを作成します。

   説明

   関数と同じリージョンに API グループを作成することをお勧めします。API が別のリージョンにある場合、インターネット経由で Function Compute サービスにアクセスする必要があり、トラフィックコストが発生します。データセキュリティとネットワーク遅延の要件が厳しい場合は、関数と同じリージョンに API グループが作成されていることを確認してください。

4. API を作成して公開します。

   以下に概説されている必須パラメーターを構成します。残りはデフォルト設定のままにしておくことができます。

   

   パラメーター	構成手順
   セキュリティ認証	認証なしを選択します。
   構成モード	既存のバックエンドサービスを使用するを選択します。
   バックエンドサービスタイプ	Function Compute を選択します。
   バージョン	Function Compute V3.0 を選択します。
   関数タイプ	イベント関数を選択します。
   バックエンドサービス	イベント関数を指す、作成したバックエンドサービスを選択します。

ステップ 3: 関数コードを記述する

1. Function Compute コンソール にログインします。左側のナビゲーションウィンドウで、[関数] をクリックします。

2. 上部のナビゲーションバーで、リージョンを選択します。[関数] ページで、管理する関数をクリックします。

3. [関数の詳細] ページの [コード] タブで、コードエディタにコードを記述し、[デプロイ] をクリックします。

   さまざまな言語のサンプルコードは次のとおりです。

   Node.js

   module.exports.handler = function(event, context, callback) { 
      var event = JSON.parse(event);
      var content = {
        path: event.path,
        method: event.method,
        headers: event.headers,
        queryParameters: event.queryParameters,
        pathParameters: event.pathParameters,
        body: event.body
      // ここに独自のロジックを記述できます。   
      }
      var response = {
           isBase64Encoded: false,
           statusCode: '200',
           headers: {
             'x-custom-header': 'header value'
           },
           body: content
         }; 
      callback(null, response)
   };                               

   Python

   # -*- coding: utf-8 -*-
   import json
   
   def handler(event, context):
       event = json.loads(event)
       content = {
           'path': event['path'],
           'method': event['httpMethod'],
           'headers': event['headers'],
           'queryParameters': event['queryParameters'],
           'pathParameters': event['pathParameters'],
           'body': event['body']
       }
       # ここに独自のロジックを記述できます。  
       rep = {
           "isBase64Encoded": "false",
           "statusCode": "200",
           "headers": {
               "x-custom-header": "no"
           },
           "body": content
       }
       return json.dumps(rep)   

   PHP

   <?php
   function handler($event, $context) {
       $event   = json_decode($event, $assoc = true);
       $content = [
           'path'            => $event['path'],
           'method'          => $event['httpMethod'],
           'headers'         => $event['headers'],
           'queryParameters' => $event['queryParameters'],
           'pathParameters'  => $event['pathParameters'],
           'body'            => $event['body'],
       ];
   
       $rep = [
           "isBase64Encoded" => "false",
           "statusCode"      => "200",
           "headers"         => [
               "x-custom-header" => "no",
           ],
           "body"            => $content,
       ];
   
       return json_encode($rep);
   } 

   Java

   Function Compute 用に Java でプログラミングする場合、事前定義されたハンドラーメソッドを使用するクラスを実装する必要があります。2 つの事前定義されたハンドラーメソッドがあります。Java ランタイムの詳細については、「コードパッケージのコンパイルとデプロイ」をご参照ください。

   • (推奨) PojoRequestHandler<I, O> ハンドラーを使用します。

     import com.aliyun.fc.runtime.Context;
     import com.aliyun.fc.runtime.PojoRequestHandler;
     import java.util.HashMap;
     import java.util.Map;
     
     public class ApiTriggerDemo implements PojoRequestHandler<ApiRequest, ApiResponse> {
     
         public ApiResponse handleRequest(ApiRequest request, Context context) {
             // API リクエスト情報を取得します。
             context.getLogger().info(request.toString());
             String path = request.getPath();
             String httpMethod = request.getHttpMethod();
             String body = request.getBody();
             context.getLogger().info("path:" + path);
             context.getLogger().info("httpMethod:" + httpMethod);
             context.getLogger().info("body:" + body);
     
             // ここに独自のロジックを記述できます。
     
             // API レスポンスの例。
             Map headers = new HashMap();
             boolean isBase64Encoded = false;
             int statusCode = 200;
             String returnBody = "";
             return new ApiResponse(headers,isBase64Encoded,statusCode,returnBody);
         }
     }                                        

     • 次のサンプルでは、2 つの POJO クラス、ApiRequest と ApiResponse を定義しています。

       説明

       POJO クラスの set() メソッドと get() メソッドを指定する必要があります。

       import java.util.Map;
       
       public class ApiRequest {
           private String path;
           private String httpMethod;
           private Map headers;
           private Map queryParameters;
           private Map pathParameters;
           private String body;
           private boolean isBase64Encoded;
       
           @Override
           public String toString() {
               return "Request{" +
                       "path='" + path + '\'' +
                       ", httpMethod='" + httpMethod + '\'' +
                       ", headers=" + headers +
                       ", queryParameters=" + queryParameters +
                       ", pathParameters=" + pathParameters +
                       ", body='" + body + '\'' +
                       ", isBase64Encoded=" + isBase64Encoded +
                       '}';
           }
       
           public String getPath() {
               return path;
           }
       
           public void setPath(String path) {
               this.path = path;
           }
       
           public String getHttpMethod() {
               return httpMethod;
           }
       
           public void setHttpMethod(String httpMethod) {
               this.httpMethod = httpMethod;
           }
       
           public Map getHeaders() {
               return headers;
           }
       
           public void setHeaders(Map headers) {
               this.headers = headers;
           }
       
           public Map getQueryParameters() {
               return queryParameters;
           }
       
           public void setQueryParameters(Map queryParameters) {
               this.queryParameters = queryParameters;
           }
       
           public Map getPathParameters() {
               return pathParameters;
           }
       
           public void setPathParameters(Map pathParameters) {
               this.pathParameters = pathParameters;
           }
       
           public String getBody() {
               return body;
           }
       
           public void setBody(String body) {
               this.body = body;
           }
       
           public boolean getIsBase64Encoded() {
               return this.isBase64Encoded;
           }
       
           public void setIsBase64Encoded(boolean base64Encoded) {
               this.isBase64Encoded = base64Encoded;
           }
       }                                      

       import java.util.Map;
       
       public class ApiResponse {
           private Map headers;
           private boolean isBase64Encoded;
           private int statusCode;
           private String body;
       
           public ApiResponse(Map headers, boolean isBase64Encoded, int statusCode, String body) {
               this.headers = headers;
               this.isBase64Encoded = isBase64Encoded;
               this.statusCode = statusCode;
               this.body = body;
           }
       
           public Map getHeaders() {
               return headers;
           }
       
           public void setHeaders(Map headers) {
               this.headers = headers;
           }
       
           public boolean getIsBase64Encoded() {
               return isBase64Encoded;
           }
       
           public void setIsBase64Encoded(boolean base64Encoded) {
               this.isBase64Encoded = base64Encoded;
           }
       
           public int getStatusCode() {
               return statusCode;
           }
       
           public void setStatusCode(int statusCode) {
               this.statusCode = statusCode;
           }
       
           public String getBody() {
               return body;
           }
       
           public void setBody(String body) {
               this.body = body;
           }
       }                                       

     • 次のコードは、pom.xml ファイルの例を示しています。

       <?xml version="1.0" encoding="UTF-8"?>
       <project xmlns="http://maven.apache.org/POM/4.0.0"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
           <modelVersion>4.0.0</modelVersion>
       
           <groupId>apiTrigger</groupId>
           <artifactId>apiTrigger</artifactId>
           <version>1.0-SNAPSHOT</version>
           <build>
               <plugins>
                   <plugin>
                       <groupId>org.apache.maven.plugins</groupId>
                       <artifactId>maven-compiler-plugin</artifactId>
                       <configuration>
                           <source>1.8</source>
                           <target>1.8</target>
                       </configuration>
                   </plugin>
               </plugins>
           </build>
           <dependencies>
               <dependency>
                   <groupId>com.aliyun.fc.runtime</groupId>
                   <artifactId>fc-java-core</artifactId>
                   <version>1.0.0</version>
               </dependency>
           </dependencies>   
       </project>                                        

   • StreamRequestHandler ハンドラーを使用します。

     このハンドラーを使用するには、InputStream を POJO クラスに変換する必要があります。次のサンプルコードは、このハンドラーの使用方法を示しています。

     pom.xml ファイルの構成は、PojoRequestHandler<I, O> ハンドラーを使用する場合と同じです。

     import com.aliyun.fc.runtime.Context;
     import com.aliyun.fc.runtime.StreamRequestHandler;
     import com.aliyun.fc.runtime.Context;
     import com.google.gson.Gson;
     import java.io.*;
     import java.util.Base64;
     import java.util.HashMap;
     import java.util.Map;
     
     public class ApiTriggerDemo2 implements StreamRequestHandler {
     
         public void handleRequest(InputStream inputStream, OutputStream outputStream, Context context) {
             try {
                 // InputStream を文字列に変換します。
                 BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(inputStream));
                 StringBuffer stringBuffer = new StringBuffer();
                 String string = "";
                 while ((string = bufferedReader.readLine()) != null) {
                     stringBuffer.append(string);
                 }
                 String input = stringBuffer.toString();
                 context.getLogger().info("inputStream: " + input);
                 Request req = new Gson().fromJson(input, Request.class);
                 context.getLogger().info("input req: ");
                 context.getLogger().info(req.toString());
                 String bodyReq = req.getBody();
                 Base64.Decoder decoder = Base64.getDecoder();
                 context.getLogger().info("body: " + new String(decoder.decode(bodyReq)));
     
                 // ここに独自のロジックを記述できます。
     
                 // 返された結果。
                 Map headers = new HashMap();
                 headers.put("x-custom-header", " ");
                 boolean isBase64Encoded = false;
                 int statusCode = 200;
                 Map body = new HashMap();
                 Response resp = new Response(headers, isBase64Encoded, statusCode, body);
                 String respJson = new Gson().toJson(resp);
                 context.getLogger().info("outputStream: " + respJson);
                 outputStream.write(respJson.getBytes());
             } catch (IOException e) {
                 e.printStackTrace();
             } finally {
                 try {
                     outputStream.close();
                     inputStream.close();
                 } catch (IOException e) {
                     e.printStackTrace();
                 }
             }
         }
         class Request {
             private String path;
             private String httpMethod;
             private Map headers;
             private Map queryParameters;
             private Map pathParameters;
             private String body;
             private boolean isBase64Encoded;
     
             @Override
             public String toString() {
                 return "Request{" +
                         "path='" + path + '\'' +
                         ", httpMethod='" + httpMethod + '\'' +
                         ", headers=" + headers +
                         ", queryParameters=" + queryParameters +
                         ", pathParameters=" + pathParameters +
                         ", body='" + body + '\'' +
                         ", isBase64Encoded=" + isBase64Encoded +
                         '}';
             }
     
             public String getBody() {
                 return body;
             }
         }
     
         // Function Compute は、次の JSON 形式で API Gateway にレスポンスを返します。
         class Response {
             private Map headers;
             private boolean isBase64Encoded;
             private int statusCode;
             private Map body;
     
             public Response(Map headers, boolean isBase64Encoded, int statusCode, Map body) {
                 this.headers = headers;
                 this.isBase64Encoded = isBase64Encoded;
                 this.statusCode = statusCode;
                 this.body = body;
             }
         }
     }                                        

ステップ 4: 関数の入力パラメーターを構成する

API Gateway が関数をトリガーすると、イベントオブジェクトの形式で情報を関数に渡します。この情報を使用して、関数をデバッグできます。

1. 関数詳細ページの [コード] タブで、 アイコンをクリックし、[関数をテスト] の隣にあるドロップダウン リストから [テスト パラメーターの構成] を選択します。

2. [テストパラメーターの構成] パネルで、[新しいテストイベントの作成] タブまたは [既存のテストイベントの変更] タブをクリックし、イベント名とイベントコンテンツを入力して、[OK] をクリックします。

   イベントオブジェクトの例は次のとおりです。

   {
       "path":"api request path",
       "httpMethod":"request method name",
       "headers":{all headers,including system headers},
       "queryParameters":{query parameters},
       "pathParameters":{path parameters},
       "body":"string of request payload",
       "isBase64Encoded":"true|false, indicate if the body is Base64-encode"
   }  

   次の表に、イベントオブジェクトのパラメーターを示します。

   パラメーター	タイプ	説明
   path	文字列	API リクエストパス。
   httpMethod	文字列	リクエストメソッド。有効な値: GET、POST、PUT、DELETE。
   headers	オブジェクト	リクエストヘッダー情報。システムヘッダーとカスタムヘッダーの両方を含む、すべてのリクエストヘッダーが含まれます。
   queryParameters	オブジェクト	クエリパラメーター。通常は、URL の疑問符の後に表示されるキーと値のペアの形式です。
   pathParameters	オブジェクト	パスパラメーター。通常は URL の一部であり、特定のリソースを識別するために使用されます。
   body	文字列	リクエスト本文。
   isBase64Encoded	ブール値	リクエスト本文が Base64 エンコーディングであるかどうかを指定します。 説明 isBase64Encoded の値が true の場合、API Gateway が Function Compute に送信する body コンテンツは Base64 エンコードされます。Function Compute は、コンテンツを処理する前に、body コンテンツを Base64 形式からデコードします。 isBase64Encoded の値が false の場合、API Gateway は body コンテンツで Base64 エンコーディングを実行しなかったため、Function Compute は body コンテンツを直接取得できます。

3. [関数のテスト] をクリックします。

ステップ 5: 結果を表示する

関数が実行された後、[コード] タブで結果を表示できます。

{
    "isBase64Encoded":true|false,
    "statusCode":httpStatusCode,
    "headers":{response headers},
    "body":"..."
}       

ステップ 1: Web 関数を作成する

Function Compute コンソールで Web 関数を作成します。詳細については、「ステップ 1: Web 関数を作成する」をご参照ください。

作成した Web 関数に対して HTTP トリガーが自動的に作成されます。後で使用するために内部エンドポイントをコピーします。

ステップ 2: バックエンドサービスを作成する

API Gateway でバックエンドサービスを作成し、バックエンドサービスの URL が Function Compute サービスを指すように構成する必要があります。

1. API Gateway コンソール にログインします。左側のナビゲーションウィンドウで、[API の管理] > [バックエンドサービス] を選択します。上部のナビゲーションバーで、リージョンを選択します。次に、右上隅にある [バックエンドサービスの作成] をクリックし、次の図に示すようにパラメーターを構成して、[確認] をクリックします。

   

2. [バックエンドサービス] ページで、作成したバックエンドサービスをクリックします。[バックエンドサービスの定義] ページで、[本番環境] タブをクリックします。[基本情報] セクションで、[作成] をクリックします。ステップ 1 でコピーした内部エンドポイントを貼り付けて、[公開] をクリックします。

   

手順 5: 結果を確認する

次のセクションでは、AppCode ベースの認証方式を使用して、業務システムで公開済みの API を呼び出す方法について説明します。この例では、Curl コマンドを使用して API 呼び出しを行います。

API Gateway コンソール にログインします。左側のナビゲーションウィンドウで、[API の呼び出し] > [アプリ] を選択します。[アプリ] ページで、承認されたアプリケーションをクリックし、表示されるページで AppCode を取得します。次に、次のサンプルコードを使用して API を呼び出します。

curl -i -X GET "http://fd6f8e2b7bf44ab181a56****-cn-hangzhou.alicloudapi.com" -H "Authorization:APPCODE 7d2b7e4945ce44028ab00***"