リクエスト

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

メソッド	URI
POST	/products/{product-id}/apis/{api-id}/resources/import

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`product-id`	String	Required	APIが属する Product ID 0~10文字 Productリストの照会を通じて確認
`api-id`	String	Required	API ID 0~10文字 APIの照会を通じて確認

リクエスト構文

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

{
    "importValidateType" : "FAIL_ON_WARN",
    "swagger" : "swagger"
}

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`importValidateType`	String	Optional	警告発生時のアクション `FAIL_ON_WARN` \| `IGNORE_WARN` `FAIL_ON_WARN`: 警告失敗 `IGNORE_WARN`: 警告無視
`swagger`	String	Required	インポートする Swaggerのすべての値

リクエスト例

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

curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/resources/import' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'\
--header 'Content-Type: application/json' \
--data '{
    "importValidateType": "IGNORE_WARN",
    "swagger": "{\n  \"openapi\" : \"3.0.1\",\n  \"info\" : {\n    \"title\" : \"3-0openapi\",\n    \"description\" : \"<br/>https://***038m***.apigw.ntruss.com/3-0openapi/v1\",\n    \"version\" : \"2024-04-25T10:08:52Z\"\n  },\n  \"servers\" : [ {\n    \"url\" : \"https://***038m***.apigw.ntruss.com/3-0openapi/v1\"\n  } ],\n (省略)  \"x-original-swagger-version\" : \"2.0\"\n}"
}'

レスポンス

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

レスポンス構文

レスポンス構文は次の通りです。

{
    "errorMessages" : [ "errorMessages" ],
    "warnMessages" : [ "warnMessages" ],
    "success" : true,
    "resourceList" : [ {
        "corsMaxAge" : "corsMaxAge",
        "resourceId" : "resourceId",
        "corsAllowMethods" : "corsAllowMethods",
        "methods" : [ {
            "methodName" : "ANY",
            "methodCode" : "methodCode"
        } ],
        "corsAllowOrigin" : "corsAllowOrigin",
        "resourcePath" : "resourcePath",
        "corsAllowCredentials" : "corsAllowCredentials",
        "corsExposeHeaders" : "corsExposeHeaders",
        "apiId" : "apiId",
        "corsAllowHeaders" : "corsAllowHeaders"
    } ]
}

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

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

レスポンス例

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

{
    "success": true,
    "warnMessages": [],
    "errorMessages": [],
    "resourceList": [
        {
            "methods": [
                {
                    "methodCode": "0001",
                    "methodName": "GET"
                }
            ],
            "resourceId": "***i8xy***",
            "resourcePath": "/{domainCode}"
        },
        {
            "methods": [
                {
                    "methodCode": "0006",
                    "methodName": "OPTIONS"
                }
            ],
            "resourceId": "***3pbq***",
            "resourcePath": "/ncp",
            "corsAllowOrigin": "*",
            "corsAllowMethods": "GET,POST,HEAD",
            "corsAllowHeaders": "content-type,x-ncp-apigw-api-key,x-ncp-apigw-timestamp,x-ncp-iam-access-key,x-ncp-apigw-signature-v1,x-ncp-apigw-signature-v2",
            "corsAllowCredentials": "",
            "corsMaxAge": "",
            "corsExposeHeaders": ""
        },
// (省略)
    ]
}

この記事は役に立ちましたか?

リクエスト
レスポンス