APIG Event Source

API Gateway (APIG) is an API hosting service that helps enterprises to build, manage, and deploy APIs at any scale. With APIG, your function can be invoked through HTTPS by using a custom REST API and a specified backend. You can map each API operation (such as, GET and PUT) to a specific function. APIG invokes the relevant function when an HTTPS request is sent to the API backend.

For more information about how to use HTTPS calls to trigger functions, see Using an APIG (Dedicated) trigger.

Example APIG Event

{
  "body": "{\"test\":\"body\"}",
  "requestContext": {
    "apiId": "bc1dcffd-aa35-474d-897c-d53425a4c08e",
    "requestId": "11cdcdcf33949dc6d722640a13091c77",
    "stage": "RELEASE"
  },
  "queryStringParameters": {
    "responseType": "html"
  },
  "httpMethod": "GET",
  "pathParameters": {
    "path":"value"
  },
  "headers": {
    "accept-language": "en-US;q=0.3,en;q=0.2",
    "accept-encoding": "gzip, deflate, br",
    "x-forwarded-port": "443",
    "x-forwarded-for": "103.218.216.98",
    "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
    "upgrade-insecure-requests": "1",
    "host": "50eedf92-c9ad-4ac0-827e-d7c11415d4f1.apigw.region.cloud.com",
    "x-forwarded-proto": "https",
    "pragma": "no-cache",
    "cache-control": "no-cache",
    "x-real-ip": "103.218.216.98",
    "user-agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:57.0) Gecko/20100101 Firefox/57.0"
  },
  "path": "/apig-event-template",
  "isBase64Encoded": true
}

Parameter description

Parameter	Type	Example Value	Description
body	String	“{"test":"body"}”	Actual request in string format.
requestContext	Map	See the example.	Request information, including the API gateway configuration, request ID, authentication information, and source.
httpMethod	String	GET	HTTP method
queryStringParameters	Map	See the example.	Query strings configured in APIG and their actual values
pathParameters	Map	See the example.	Path parameters configured in APIG and their actual values
headers	Map	See the example.	Complete headers
path	String	/apig-event-template	Complete path
isBase64Encoded	Boolean	True	Default value: true (see Notes below)

Notes

• When calling a function using APIG, isBase64Encoded is valued true by default, indicating that the request body transferred to FunctionGraph is encoded using Base64 and must be decoded for processing.

• The function must return characters strings by using the following structure.

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

Example

handler.go

package main

import (
	"encoding/json"
	"fmt"

	"github.com/opentelekomcloud-community/otc-functiongraph-go-runtime/go-runtime/events/apig"
	"github.com/opentelekomcloud-community/otc-functiongraph-go-runtime/go-runtime/go-api/context"
	"github.com/opentelekomcloud-community/otc-functiongraph-go-runtime/go-runtime/pkg/runtime"
)

// Example for API Gateway (Dedicated Gateway) handler
func ApigTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {

	var apigEvent apig.APIGTriggerEvent
	err := json.Unmarshal(payload, &apigEvent)
	if err != nil {
		fmt.Println("Unmarshal failed")
		return "invalid data", err
	}
	ctx.GetLogger().Logf("payload:%s", apigEvent.String())
	apigResp := apig.APIGTriggerResponse{
		Body: apigEvent.String(),
		Headers: map[string]string{
			"content-type": "application/json",
		},
		StatusCode: 200,
	}

	return apigResp, nil
}

func main() {
	runtime.Register(ApigTest)
}

last updated: 2025-10-24 14:39:45 UTC - commit: 373fe56a6b249d6515a713ff6d87064ece946718