Resource
    • PDF

    Resource

    • PDF

    Article Summary

    Resource生成

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    {
      "corsMaxAge" : "corsMaxAge",
      "corsAllowMethods" : "corsAllowMethods",
      "corsAllowOrigin" : "corsAllowOrigin",
      "resourcePath" : "resourcePath",
      "corsAllowCredentials" : "corsAllowCredentials",
      "corsExposeHeaders" : "corsExposeHeaders",
      "corsAllowHeaders" : "corsAllowHeaders"
    }
    

    応答コード

    • 201

    応答ボディ

    {
      "resource" : {
        "corsMaxAge" : "corsMaxAge",
        "resourceId" : "resourceId",
        "corsAllowMethods" : "corsAllowMethods",
        "methods" : [ {
          "methodName" : "ANY",
          "methodCode" : "methodCode"
        } ],
        "corsAllowOrigin" : "corsAllowOrigin",
        "resourcePath" : "resourcePath",
        "corsAllowCredentials" : "corsAllowCredentials",
        "corsExposeHeaders" : "corsExposeHeaders",
        "apiId" : "apiId",
        "corsAllowHeaders" : "corsAllowHeaders"
      }
    }
    

    Resource削除

    URL

    DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    resourceIdpathYStringResource Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 204

    応答ボディ

    • なし

    Resource照会

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

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

    SwaggerからResourceインポート

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/import
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10

    リクエストボディ

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

    応答コード

    • 200

    応答ボディ

    {
      "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"
      } ]
    }
    

    Resource修正

    URL

    PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    resourceIdpathYStringResource Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    {
      "corsMaxAge" : "corsMaxAge",
      "corsAllowMethods" : "corsAllowMethods",
      "corsAllowOrigin" : "corsAllowOrigin",
      "corsAllowCredentials" : "corsAllowCredentials",
      "corsExposeHeaders" : "corsExposeHeaders",
      "corsAllowHeaders" : "corsAllowHeaders"
    }
    

    応答コード

    • 200

    応答ボディ

    {
      "resource" : {
        "corsMaxAge" : "corsMaxAge",
        "resourceId" : "resourceId",
        "corsAllowMethods" : "corsAllowMethods",
        "methods" : [ {
          "methodName" : "ANY",
          "methodCode" : "methodCode"
        } ],
        "corsAllowOrigin" : "corsAllowOrigin",
        "resourcePath" : "resourcePath",
        "corsAllowCredentials" : "corsAllowCredentials",
        "corsExposeHeaders" : "corsExposeHeaders",
        "apiId" : "apiId",
        "corsAllowHeaders" : "corsAllowHeaders"
      }
    }
    

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

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.