メソッド Producesの変更

Prev Next

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

設定されたメソッドの Produce情報を変更します。返されるコンテンツタイプが変更されます。

リクエスト

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

メソッド URI
PUT /products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/produces

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
product-id String Required APIが属する Product ID
api-id String Required 変更対象の API ID
resource-id String Required API内対象リソースの ID
method-name String Required 対象メソッドのタイプ
  • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD

リクエスト構文

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

{
  "produces" : "produces"
}

リクエストボディ

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

フィールド タイプ 必須の有無 説明
produces String Required 変更後のコンテンツタイプ
  • HTTPの Content-Typeヘッダに対応する値
  • 1~100文字
  • <例> application/json、application/xml、text/plain

リクエスト例

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

curl --location --request PUT 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/p1hiuvmwv3/methods/DELETE/produces' \
--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 '{
  "produces" : "text/plain"
}'

レスポンス

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

レスポンス構文

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

{
  "produces" : "produces"
}

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

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

レスポンス例

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

{
    "produces": "text/plain"
}