Function Compute：Pemicu API Gateway

1. Masuk ke Konsol API Gateway. Di panel navigasi kiri, pilih Manage APIs > Backend Services. Di bilah navigasi atas, pilih wilayah. Kemudian, klik Create Backend Service di pojok kanan atas, konfigurasikan parameter seperti yang ditunjukkan pada gambar berikut, dan klik Confirm:

   

2. Di halaman Layanan Backend, klik layanan backend yang baru saja Anda buat. Di halaman Definisi Layanan Backend, klik tab Production. Di bagian Basic Information, klik Create. Pilih fungsi event yang Anda buat di Langkah 1 dan klik Publish.

   

3. Buat grup API.

   Catatan

   Kami merekomendasikan Anda membuat grup API di wilayah yang sama dengan fungsi Anda. Jika API berada di wilayah berbeda, maka perlu mengakses layanan Function Compute Anda melalui Internet, yang akan menimbulkan biaya lalu lintas. Untuk persyaratan ketat keamanan data dan latensi jaringan, pastikan grup API dibuat di wilayah yang sama dengan fungsi Anda.

4. Buat dan publikasikan API.

   Konfigurasikan parameter yang diperlukan sesuai petunjuk di bawah ini. Anda dapat membiarkan sisanya pada pengaturan default.

   

   Parameter	Instruksi Konfigurasi
   Security Authentication	Pilih Tanpa Otentikasi.
   Configuration Mode	Pilih Gunakan Layanan Backend yang Ada.
   Backend Service Type	Pilih Function Compute.
   Version	Pilih Function Compute V3.0.
   Function Type	Pilih Fungsi Event.
   Backend Service	Pilih layanan backend yang baru saja Anda buat yang menunjuk ke fungsi event.

Langkah 3: Tulis kode fungsi

1. Masuk ke Konsol Function Compute. Di panel navigasi kiri, klik Functions.

2. Di bilah navigasi atas, pilih wilayah. Pada halaman Functions, klik fungsi yang ingin Anda kelola.

3. Pada tab Code di halaman Detail Fungsi, tulis kode di editor kode dan klik Deploy.

   Contoh kode untuk berbagai bahasa adalah sebagai berikut:

   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
      // Anda dapat menulis logika Anda sendiri di sini.   
      }
      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']
       }
       # Anda dapat menulis logika Anda sendiri di sini.  
       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

   Saat memprogram dalam Java untuk Function Compute, Anda harus mengimplementasikan sebuah kelas yang menggunakan metode handler yang telah ditentukan sebelumnya. Ada dua metode handler yang tersedia. Untuk informasi lebih lanjut tentang waktu proses Java, lihat Kompilasi dan Penyebaran Paket Kode.

   • (Direkomendasikan) Gunakan handler 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) {
             // Dapatkan informasi permintaan 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);
     
             // Anda dapat menulis logika Anda sendiri di sini. 
     
             // Contoh respons API. 
             Map headers = new HashMap();
             boolean isBase64Encoded = false;
             int statusCode = 200;
             String returnBody = "";
             return new ApiResponse(headers,isBase64Encoded,statusCode,returnBody);
         }
     }                                        

     • Berikut ini adalah contoh yang mendefinisikan dua kelas POJO: ApiRequest dan ApiResponse.

       Catatan

       Metode set() dan get() dari kelas POJO harus ditentukan.

       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;
           }
       }                                       

     • Kode berikut menunjukkan contoh file 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>                                        

   • Gunakan handler StreamRequestHandler.

     Untuk menggunakan handler ini, Anda harus mengonversi InputStream menjadi kelas POJO. Contoh kode berikut menjelaskan cara menggunakan handler ini.

     Konfigurasi file pom.xml sama seperti saat menggunakan handler 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 {
                 // Konversi InputStream menjadi string. 
                 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)));
     
                 // Anda dapat menulis logika Anda sendiri di sini. 
     
                 // Hasil yang dikembalikan. 
                 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 mengembalikan respons ke API Gateway dalam format JSON berikut. 
         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;
             }
         }
     }                                        

Langkah 4: Konfigurasi parameter input fungsi

Ketika API Gateway memicu sebuah fungsi, informasi dikirim dalam bentuk objek event ke dalam fungsi. Anda dapat menggunakan informasi ini untuk men-debug fungsi Anda.

1. Pada tab Code di halaman detail fungsi, klik ikon di sebelah Test Function, lalu pilih Configure Test Parameters dari daftar drop-down.

2. Di panel Configure Test Parameters, klik tab Create New Test Event atau Modify Existing Test Event. Masukkan nama event dan isi event, lalu klik OK.

   Berikut adalah contoh objek event:

   {
       "path":"jalur permintaan api",
       "httpMethod":"nama metode permintaan",
       "headers":{semua header, termasuk header sistem},
       "queryParameters":{parameter kueri},
       "pathParameters":{parameter jalur},
       "body":"string payload permintaan",
       "isBase64Encoded":"true|false, menunjukkan apakah body di-enkode Base64"
   }  

   Tabel berikut menjelaskan parameter dalam objek event.

   Parameter	Tipe	Deskripsi
   path	String	Jalur permintaan API.
   httpMethod	String	Metode permintaan. Nilai yang valid: GET, POST, PUT, dan DELETE.
   headers	Object	Informasi header permintaan. Ini mencakup semua header permintaan, termasuk header sistem dan header kustom.
   queryParameters	Object	Parameter kueri. Biasanya dalam bentuk pasangan kunci-nilai yang muncul setelah tanda tanya di URL.
   pathParameters	Object	Parameter jalur. Biasanya merupakan bagian dari URL dan digunakan untuk mengidentifikasi sumber daya tertentu.
   body	String	Badan permintaan.
   isBase64Encoded	Boolean	Menentukan apakah badan permintaan di-enkode dalam format Base64. Catatan Jika nilai dari isBase64Encoded adalah true, konten body yang dikirim oleh API Gateway ke Function Compute di-enkode dalam Base64. Function Compute mendekode konten body dari format Base64 sebelum memproses konten tersebut. Jika nilai dari isBase64Encoded adalah false, API Gateway tidak melakukan enkode Base64 pada konten body, dan Function Compute dapat langsung memperoleh konten body.

3. Klik Test Function.

Langkah 5: Lihat hasilnya

Setelah fungsi dijalankan, hasilnya dapat dilihat di tab Code.

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

Langkah 1: Buat fungsi web

Buat fungsi web di Konsol Function Compute. Untuk informasi lebih lanjut, lihat Langkah 1: Buat Fungsi Web.

Pemicu HTTP secara otomatis dibuat untuk fungsi web yang baru saja Anda buat. Salin titik akhir internal untuk digunakan nanti.

Langkah 2: Buat layanan backend

Anda harus membuat layanan backend di API Gateway dan mengonfigurasi URL untuk layanan backend agar menunjuk ke layanan Function Compute Anda.

1. Masuk ke Konsol API Gateway. Di panel navigasi kiri, pilih Manage APIs > Backend Services. Di bilah navigasi atas, pilih wilayah. Kemudian, klik Create Backend Service di pojok kanan atas, konfigurasikan parameter seperti yang ditunjukkan pada gambar berikut, dan klik Confirm:

   

2. Di halaman Layanan Backend, klik layanan backend yang baru saja Anda buat. Di halaman Definisi Layanan Backend, klik tab Production. Di bagian Basic Information, klik Create. Tempel titik akhir internal yang Anda salin di Langkah 1 dan klik Publish.

   

Langkah 5: Verifikasi hasilnya

Bagian berikut menjelaskan cara menggunakan metode autentikasi berbasis AppCode untuk memanggil API yang diterbitkan di sistem bisnis Anda. Contoh ini menggunakan perintah Curl untuk melakukan panggilan API.

Masuk ke Konsol API Gateway. Di panel navigasi kiri, pilih Call APIs > Apps. Di halaman Apps, klik aplikasi yang diotorisasi dan dapatkan AppCode-nya di halaman yang muncul. Kemudian, gunakan potongan kode sampel berikut untuk memanggil API:

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