リソースの管理

ここでは、リソースの概要と管理方法について説明します。

リソースについて

多くのポリシータイプはリソースに依存しています。リソースとは、API プロキシへの接続時に、ポリシーで実行すべきコードまたは構成を実装するファイルです。JavaScript や JavaCallout で見られるように、ポリシーが単にいくつかのコードを実行すべき接続ポイントを API プロキシ内で定義するだけのものである場合があります。JavaScript または JavaCallout ポリシーは、リソースへのポインタです。

以下のサンプル JavaScript は、HTTP リクエストパスを proxy.basepath 変数の値に設定します。

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

リソースタイプ

次の表に、リソースタイプと、Edge または Hybrid（ベータ版）でサポートされているかどうかをまとめています。

リソースタイプ	説明	Edge	Hybrid
JAR (java)	JavaCallout ポリシーから参照される JAR ファイル内の Java クラス。	*
JavaScript (js)	JavaScript ポリシーから参照される JavaScript。
JavaScript (jsc)	JavaScript ポリシーから参照されるコンパイル済みの JavaScript。
Hosted target (hosted)	Hosted Targets にデプロイする Node.js ファイル。Node.js を Edge バックエンド ターゲット アプリケーションとしてデプロイできます。
Node (node)	Node.js ファイル。主要な Node.js ファイル、関連するソースファイル、モジュール依存関係が含まれます。
OpenAPI Specification (oas)（ベータ版）	JSON または YAML タイプのリクエスト メッセージとレスポンス メッセージの検証に使用される OpenAPI 仕様。
Property Set (properties)	Hybrid プロパティ セットから参照される Key-Value ペアのコレクション。
Python (py)	PythonScript ポリシーから参照される Python スクリプト。リソースは「pure Python」（Python 言語のみ）で実装する必要があります。	*
WSDL (wsdl)	SOAPMessageValidation ポリシーから参照される WSDL ファイル。
XSD (xsd)	SOAPMessageValidation ポリシーから参照される XML スキーマ。
XSL Transformations (xsl)	XSLTransform ポリシーから参照される XSLT 変換。

* Edge プランのみで使用可能。Edge の料金と機能をご覧ください。

リソースの格納場所

次の場所にリソースを格納できます。

たとえば、test 環境で使用できるすべての JavaScript ファイルは次のリポジトリに格納され、test 環境で実行されているすべての API プロキシで使用できます。

/organizations/{org}/environments/test/resourcefiles/jsc

リソース名の解決

Edge と Hybrid でのリソース名解決は、最も詳細な範囲から最も広い範囲への順で行われます。リソース名は、API プロキシレベルから、環境レベル、組織レベル（Edge のみ）まで「チェーンの上位」に向かって解決されます。

API プロキシ リビジョンと prod 環境という 2 つの異なるリポジトリで、同じリソースに値を入力したと仮定しましょう。

API プロキシが以下のポリシーで構成されているとします。

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

ポリシー参照は、明示的に特定のリポジトリに対して行うことはできません。ポリシー内のリソース名と一致する名前を持つリソースのうち、最も詳細な対象を持つものが使用されます。

したがって、API プロキシが環境 prod にデプロイされる場合、ポリシーは環境スコープの pathSetter.js リソースに解決されます。

環境 test にデプロイされる場合、ポリシーは API プロキシ リビジョンをスコープとしたリソースに解決されます。環境スコープのリソースは、prod 環境に含まれるからです（test 環境ではなく）。

Java リソース ガイドライン

-T、--data-binary、-F オプション（-d オプションではない）など、複数のオプションを curl で使用することで、コンパイルした Java リソースを JAR ファイルとして追加できます。例:

curl -v -u email -H "Content-Type: application/octet-stream" \
-X POST --data-binary @{jar_file} \
"http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"

curl -v -u email -H "Content-Type: application/octet-stream" \
-X POST -T "{jar_file}" \
"http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"

curl -v -u email -H "Content-Type: multipart/form-data" \
-X POST -F "file=@{jar_file}" \
"http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"

関連情報:

• Java のベスト プラクティス: API プロキシの設計と開発のベスト プラクティス
• Java クックブック サンプル: XSL 変換ポリシー

Node.js リソース ガイドライン

API プロキシで Node.js スクリプトを参照する場合、API プロキシの TargetEndpoint 構成で <ResourceURL> 要素を使用します。詳しくは、既存の API プロキシへの Node.js の追加をご覧ください。例:

<ScriptTarget>
    <ResourceURL>node://hello-world.js</ResourceURL>
</ScriptTarget>

この Node.js スクリプトおよびすべてのサポート モジュールは、API プロキシ リビジョンの対象（プロキシ バンドルの /resources/node ディレクトリ）に配置されている必要があります。API プロキシ エディタでは、Node.js リソースを [Scripts] セクションに追加することでこの手順を実行します。API プロキシ リソースの対象にリソースを格納するには、API（import と update）を使用して格納します。

UI を使用したリソースの管理

以降のセクションで説明するように、API プロキシ リビジョンをスコープとするリソースを UI を使用して管理します。

UI を使用したリソースの表示

API プロキシ リビジョンをスコープとするリソースを表示するには:

1. 下記の手順で UI にアクセスします。

   Edge

   apigee.com/edge にログインします。

   Hybrid

   apigee.google.com/edge にログインします。

2. 左側のナビゲーション バーで [Develop] > [API Proxies] を選択します。
3. リソースを作成する API プロキシをリストから選択します。
   API プロキシ エディタが開き、デフォルトで [Overview] タブが表示されます。
4. [Develop] タブをクリックします。
5. 必要に応じて、[Revision] プルダウンでリビジョンを選択します。

   API プロキシ リビジョンをスコープとするリソースは、[Navigator] ビューの [Resources] セクションに表示されます。

   

UI を使用したリソースの作成

UI を使用して API プロキシ リビジョンをスコープとするリソースを作成するには:

1. API プロキシ リビジョンをスコープとするリソースを表示します。
2. [Navigator] ビューの [Resources] セクションで + をクリックします。[New Resource] ダイアログが表示されます。
3. 次の情報を入力します。

   フィールド	説明
   Source	新しいファイルを作成するか、ファイルをインポートします。
   File Type	プルダウン リストからリソースタイプを選択します。
   File Name	ファイルの名前。ファイル名の拡張子は、選択したファイルタイプに対して有効である必要があります。

UI を使用したリソースの更新

Apigee Hybrid のみ:
Apigee Hybrid で API プロキシ リビジョンをスコープとするリソースを更新できるのは、リビジョンがデプロイされていない場合に限ります。API プロキシ リビジョンがデプロイされた後は変更できません。

UI を使用して API プロキシ リビジョンをスコープとするリソースを更新するには:

1. API プロキシ リビジョンをスコープとするリソースを表示します。
2. [Resources] の [Navigator] ビューで、更新するリソースをクリックします。
   注: JAR ファイルの場合は、編集するリソースにカーソルを合わせて をクリックします。
3. 必要に応じてリソースを更新します。
   注: 新しい JAR ファイルをアップロードしたら、[Update] をクリックしてください。

UI を使用したリソースの削除

Apigee Hybrid のみ:
Apigee Hybrid で API プロキシ リビジョンをスコープとするリソースを削除できるのは、リビジョンがデプロイされていない場合に限ります。API プロキシ リビジョンがデプロイされた後は変更できません。

UI を使用して API プロキシ リビジョンをスコープとするリソースを削除するには:

1. API プロキシ リビジョンをスコープとするリソースを表示します。
2. [Resources] の [Navigator] ビューで、削除するリソースにカーソルを合わせて、操作メニューを表示します。
3. をクリックします。
4. [Delete] をクリックして操作を確定します。

API を使用したリソースの管理

ここでは、API を使用したリソースの管理方法について説明します。

API を使用したリソースの作成

ここでは、API プロキシ リビジョン、環境、組織（Edge のみ）をスコープとするリソースを作成する方法について説明します。

API を使用して API プロキシ リビジョンをスコープとするリソースを作成する

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

{
  "name": "pathSetter.js",
  "type": "jsc"
}

API を使用して環境をスコープとするリソースを作成する

API を使用して環境をスコープとする JavaScript リソースを作成するには、次のリソースに POST リクエストを送信します。/organizations/{org}/environments/{env}/resourcefiles

リクエストに次の情報を渡します。

• name クエリ パラメータにリソースの名前を設定します。
• type クエリ パラメータに必要なリソースタイプを設定します。
• リソース ファイルの内容を application/octet-stream または multipart/form-data として渡します。

次の例は、リクエストの本文に JavaScript リソースの内容を渡してリソースを作成する方法を示しています。

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

curl -X POST https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");'

ローカルマシンからのファイルとして、次のようにリソースをアップロードできます。JavaScript ポリシーが、環境または組織をスコープとする JavaScript ファイルにアクセスできるようにするには、curl でバイナリ アップロードに -F を使用することが重要です。

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

curl -X POST https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js

次にレスポンスの例を示します。

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

API を使用して組織をスコープとするリソースを作成する（Edge のみ）

Edge で、API を使用して組織をスコープとするリソースを作成するには、POST リクエストを次のリソースに送信します。https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles

リクエストに次の情報を渡します。

• name クエリ パラメータにリソースの名前を設定します。
• type クエリ パラメータにリソース ファイルのタイプを設定します（リソースタイプを参照）。
• リソース ファイルの内容を application/octet-stream または multipart/form-data として渡します。

詳細については、次をご覧ください。

• 組織のリソース ファイルをインポートする
• 組織のリソース ファイルをインポートする（ファイルのアップロード）

API を使用したリソースの表示

ここでは、API を使用してリソースを表示する方法について説明します。

API を使用してすべてのリソースを表示する

以降のセクションで説明するように、API を使用して環境をスコープとするすべてのリソースを表示します。

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/{type}" \
  -u email:password
  

curl -X GET https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles
  -H "Authorization: Bearer $TOKEN"

次に、レスポンスの例を示します。

{
  "resourceFile": [
{
  "name" : "pathSetter.js",
  "type" : "jsc"
}
  ]
}

API を使用してリソースの内容を表示する

以降のセクションで説明するように、API を使用してリソースの内容を表示します。

API を使用して環境内のリソースの内容を表示するには、GET リクエストを次のリソースに送信します。/organizations/{org}/environments/{env}/resourcefiles/{type}/name

次の例では、テスト環境内の pathSetter.js JavaScript リソース ファイルの内容が表示されます。

curl -X GET https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js" \
  -H "Accept: application/json" \
  -u email

curl -X GET https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN"

次にレスポンスの例を示します。

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

API を使用したリソースの更新

ここでは、API プロキシ リビジョン、環境、組織（Edge のみ）をスコープとするリソースを更新する方法について説明します。

API を使用して API プロキシ リビジョンをスコープとするリソースを更新する

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

{
  "name": "pathSetter.js",
  "type": "jsc"
}

API を使用して環境をスコープとするリソースを更新する

API を使用して環境をスコープとするリソースを更新するには、次のリソースに PUT リクエストを送信します。/organizations/{org}/environments/{env}/resourcefiles/{type}/{name}

リソース ファイルの内容を application/octet-stream または multipart/form-data として渡します。

次の例は、リクエストの本文に JavaScript リソースの内容を渡してリソースを更新する方法を示しています。

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

curl -X PUT https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");'

次の例は、ローカルマシンのファイルを使用してリソース ファイルを更新する方法を示しています。JavaScript ポリシーが、環境または組織をスコープとする JavaScript ファイルにアクセスできるようにするには、curl でバイナリ アップロードに -F を使用することが重要です。

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

curl -X PUT https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js

次にレスポンスの例を示します。

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

API を使用して組織をスコープとするリソースを更新する（Edge のみ）

Edge で、API を使用して組織をスコープとするリソースを更新するには、POST リクエストを次のリソースに送信します。https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}

リソース ファイルの内容を application/octet-stream または multipart/form-data として渡します。

詳細については、次をご覧ください。

• 組織のリソース ファイルをインポートする
• 組織のリソース ファイルをインポートする（ファイルのアップロード）

API を使用したリソースの削除

ここでは、API プロキシ リビジョン、環境、組織（Edge のみ）をスコープとするリソースを削除する方法について説明します。

API を使用して API プロキシ リビジョンをスコープとするリソースを削除する

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js" \
  -u email:password
  

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

API を使用して環境をスコープとするリソースを削除する

ここでは、API を使用して環境をスコープとするリソースを削除する方法について説明します。

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js" \
  -u email:password
  

curl -X DELETE https://apigee.googleapis.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js \
  -H "Authorization: Bearer $TOKEN"
  

次に、レスポンスの例を示します。

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

API を使用して組織をスコープとするリソースを削除する（Edge のみ）

Edge で、API を使用して組織をスコープとするリソースを削除するには、DELETE リクエストを次のリソースに送信します。https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}

詳細については、組織からのリソース ファイルの削除をご覧ください。

リソースへのアクセス

リソースへのアクセス方法は、リソースタイプによって異なります。詳細については、関連するポリシーのドキュメントをご覧ください。

以下に、pathSetter.js という名前の JavaScript リソースを作成して管理し、JavaScript タイプのポリシーから参照できるようにする方法を示します。

JavaScript をリクエスト PostFlow に添付するには、ファイル pathSetter.js を参照する PathSetterPolicy.xml というポリシーを作成します。

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

Endpoint 構成でこのポリシーを参照します。

<PostFlow>
  <Request>
    <Step><Name>PathSetterPolicy</Name></Step>
  </Request>
<PostFlow>

詳しくは、JavaScript ポリシーをご覧ください。