Authorizerのテスト

Prev Next

Classic/VPC環境で利用できます。

作成した Authorizerをテストします。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /authorizers/{authorizer-id}/test

リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
authorizer-id String Required テスト対象の Authorizer ID

リクエスト構文

リクエスト構文は次の通りです。

{
  "params" : "{}"
}

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
params String Optional テスト対象の payloadの名前と値
  • <例> "Test_123" : "{}"

リクエスト例

リクエストのサンプルコードは次の通りです。

curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}/test' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
  "payload-***" : "{}"
}'

レスポンス

レスポンス形式を説明します。

レスポンス構文

構文は次の通りです。

{
    "response": {
        "latency": "latency",
        "status": status,
        "header": {[]},
        "body": "{}"
    }
}

レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "response": {
        "latency": "22 ms",
        "status": 202,
        "header": {
            "Server": [
                "nginx"
            ],
            "Date": [
                "Fri, 03 May 2024 05:15:41 GMT"
            ],
            "Content-Type": [
                "application/json"
            ],
            "Content-Length": [
                "51"
            ],
            "Connection": [
                "keep-alive"
            ],
            "X-Request-ID": [
                "*****87ed34d5d19b9871ccd017ffe9c",
                "*****87ed34d5d19b9871ccd017ffe9c"
            ],
            "Access-Control-Allow-Origin": [
                "*"
            ],
            "Access-Control-Allow-Headers": [
                "Authorization, Origin, X-Requested-With, Content-Type, Accept, User-Agent"
            ],
            "Access-Control-Allow-Methods": [
                "GET, DELETE, POST, PUT, HEAD"
            ],
            "x-openwhisk-activation-id": [
                "*****8db2b45b4959c08db2b85b41b"
            ]
        },
        "body": "{\"activationId\":\"*****c08db2b45b4959c08db2b85b41b\"}"
    }
}