Function Compute:API Gateway トリガー

1. API Gateway コンソールにログインし、リージョンを選択します。左側のナビゲーションウィンドウで、API 管理 > バックエンドサービス を選択します。右上隅の バックエンドサービスの作成 をクリックします。以下の情報を構成し、確認 をクリックします。

   

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

   

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

   説明

   関数と同じリージョンに API グループを作成してください。異なるリージョンの場合、API はパブリックネットワーク経由でご利用の Function Compute サービスにアクセスする必要があり、トラフィック料金が発生します。データセキュリティおよびネットワーク遅延に対して高い要件がある場合は、API と関数を同じリージョンに配置してください。

4. API の作成および公開を行います。

   以下の主要な設定項目を構成します。その他の項目はデフォルト設定のままとします。

   

   設定項目	例
   セキュリティ 認証	認証なし
   設定モード	既存のバックエンドサービスを使用
   バックエンドサービスのタイプ	Function Compute
   プロダクトバージョン	Function Compute 3.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

   Java を使用する場合、Function Compute の事前定義ハンドラを実装するクラスを作成する必要があります。以下の 2 つの事前定義ハンドラのいずれかを実装できます。Function Compute の 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 の定義を以下に示します。

       説明

       set() および get() メソッドは、POJO クラスで完全に実装されている必要があります。

       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 は、API Gateway に応答を返す際に、以下の JSON 形式で返す必要があります。
         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 が関数をトリガーすると、API 関連の情報がイベントとして関数の入力パラメーターに渡されます。このイベント情報を使用して、関数コードが正しく動作するかどうかをテストできます。

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

2. テストパラメーターの設定 パネルで、新規テストイベントの作成 または 既存のテストイベントの変更 を選択します。イベント名および内容を入力し、[OK] をクリックします。

   以下の例に、イベントの形式を示します：

   {
       "path":"API リクエストパス",
       "httpMethod":"リクエストメソッド名",
       "headers":{すべてのヘッダー（システムヘッダーを含む）},
       "queryParameters":{クエリパラメーター},
       "pathParameters":{パスパラメーター},
       "body":"リクエストペイロードの文字列",
       "isBase64Encoded":"true|false、ボディが Base64 エンコードされているかどうかを示す"
   }  

   以下の表に、イベントパラメーターのフィールドを説明します。

   パラメーター	型	説明
   path	String	API リクエストのパスです。
   httpMethod	String	GET、POST、PUT、DELETE などのリクエストメソッド名です。
   headers	Object	システムヘッダーおよびカスタムヘッダーを含むすべてのリクエストヘッダー情報を含みます。
   queryParameters	Object	クエリパラメーターで、通常は URL の疑問符 (?) の後にキーと値のペアとして表示されます。
   pathParameters	Object	パスパラメーターで、通常は URL の一部であり、特定のリソースを識別するために使用されます。
   body	String	リクエストボディです。
   isBase64Encoded	Boolean	リクエストボディが Base64 エンコードされているかどうかを示します。 説明 isBase64Encoded の値が true の場合、API Gateway から Function Compute に渡される body コンテンツは Base64 エンコードされています。Function Compute は、処理前に body コンテンツを Base64 デコードする必要があります。 isBase64Encoded の値が false の場合、API Gateway は body コンテンツを Base64 エンコードしません。関数内で body コンテンツを直接取得できます。

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

ステップ 5：結果の検証

実行が完了すると、コード タブの上部に結果を表示できます。

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

ステップ 1：Web 関数の作成

Function Compute 3.0 コンソールで Web 関数を作成します。詳細については、「Web 関数の作成」をご参照ください。

デフォルトで、Web 関数には HTTP トリガーが作成されます。後で使用するため、内部ネットワークのエンドポイントをコピーします。

ステップ 2：バックエンドサービスの作成

API Gateway でバックエンドサービスを定義し、そのエンドポイントを Function Compute に接続するよう構成します。

1. API Gateway コンソールにログインし、リージョンを選択します。左側のナビゲーションウィンドウで、API 管理 > バックエンドサービス を選択します。右上隅の バックエンドサービスの作成 をクリックします。以下の情報を構成し、確認 をクリックします。

   

2. バックエンドサービスページで、先ほど作成したバックエンドサービスをクリックして、バックエンドサービス定義ページに移動します。本番環境 タブをクリックします。基本情報 セクションで、作成 をクリックします。ステップ 1 で作成した Web 関数のトリガーの内部ネットワークエンドポイントを入力し、公開 をクリックします。

   

ステップ 5：結果の検証

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

API Gateway コンソールにログインします。左側のナビゲーションウィンドウで、API 呼び出し > アプリケーション管理 を選択します。アプリケーションと権限付与 ページで、権限付与済みの APP を見つけ、それをクリックして APPCode を取得します。その後、以下の例に示すように API を呼び出します。

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