APIデプロイメント仕様の作成

コンソールでダイアログを使用してAPIデプロイメントを作成する際に、APIデプロイメント仕様を作成するには、コンソールを使用してAPIデプロイメントを最初から作成を参照してください。

JSONファイルでAPIデプロイメント仕様を作成するには:

1. 任意のJSONエディタを使用し、JSONファイル内に次のフォーマットでAPIデプロイメント仕様を作成します:

   {
     "requestPolicies": {},
     "routes": [
       {
         "path": "<api-route-path>",
         "methods": ["<method-list>"],
         "backend": {
           "type": "<backend-type>",
           "<backend-target>": "<identifier>"
         },
         "requestPolicies": {}
       }
     ]
   }

   ここでは:

   • "requestPolicies"は、APIデプロイメントの動作を制御するオプションのポリシーを指定します。APIデプロイメント仕様のすべてのルートにポリシーを適用する場合は、routesセクションの外にポリシーを配置します。特定のルートのみにポリシーを適用する場合は、ポリシーをroutesセクション内に配置します。APIデプロイメント仕様へのリクエスト・ポリシーとレスポンス・ポリシーの追加を参照してください。

   • <api-route-path>には、バックエンド・サービスに対してリストされているメソッドを使用して、APIコールのパスを指定します。指定するルート・パスで次の点に注意してください:

     • デプロイメント・パス接頭辞に対して相対的です(APIデプロイメントの作成によるAPIゲートウェイへのAPIのデプロイを参照)
     • 先頭にスラッシュ(/)を付ける必要があります。単一のスラッシュのみも可能です
     • スラッシュは複数使用でき(連続していない場合)、スラッシュで終了できます
     • 英数字の大文字と小文字を使用できます
     • 特殊文字$ - _ . + ! * ' ( ) , % ; : @ & = を使用できます
     • パラメータおよびワイルドカードを使用できます(ルート・パスへのパス・パラメータおよびワイルドカードの追加を参照)
   • <method-list>は、バックエンド・サービスによって受け入れられる1つ以上のメソッドをカンマで区切って指定します。たとえば、"GET, PUT"です。
   • <backend-type>は、バックエンド・サービスのタイプを指定します。有効な値は、ORACLE_FUNCTIONS_BACKEND、HTTP_BACKENDおよびSTOCK_RESPONSE_BACKENDです。
   • <backend-target>および<identifier>は、バックエンド・サービスを指定します。<backend-target>および<identifier>の有効な値は、次に示すように<backend-type>の値に依存します:
     • <backend-type>をORACLE_FUNCTIONS_BACKENDに設定した場合は、<backend-target>をfunctionIdに置き換え、<identifier>をファンクションのOCIDに置き換えます。たとえば、"functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab5b..."です。APIゲートウェイ・バックエンドとしてのOCI Functionsでのファンクションの追加を参照してください。
     • <backend-type>をHTTP_BACKENDに設定した場合は、<backend-target>をurlに置き換え、<identifier>をバックエンド・サービスのURLに置き換えます。たとえば、"url": "https://api.weather.gov"です。APIゲートウェイ・バック・エンドとしてのHTTPまたはHTTPS URLの追加を参照してください。
     • <backend-type>をSTOCK_RESPONSE_BACKENDに設定した場合は、<backend-target>と<identifier>を適切なキーと値のペアに置き換えます。APIゲートウェイ・バック・エンドとしての標準レスポンスの追加を参照してください。

   たとえば、次の基本的なAPIデプロイメント仕様では、OCI Functionsの単純なHello Worldサーバーレス・ファンクションを単一のバックエンドとして定義しています:

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         }
       }
     ]
   }

   複数のバック・エンドを定義する、より複雑な例は、複数のバック・エンドを含むAPIデプロイメント仕様の例を参照してください。

2. APIデプロイメント仕様を含むJSONファイルを保存します。

3. APIデプロイメント仕様は、次の方法でAPIデプロイメントを作成または更新するときに使用します:

   • 「既存のAPIのアップロード」オプションを選択して、コンソールでJSONファイルを指定します
   • APIゲートウェイREST APIへのリクエストでJSONファイルを指定します

   詳細は、APIデプロイメントの作成によるAPIゲートウェイへのAPIのデプロイを参照してください。

APIリソース用にアップロードしたAPI記述ファイルに基づいてAPIデプロイメント仕様を作成するには、API記述を含めたAPIリソースの作成を参照してください

API記述ファイルにはAPIデプロイメント仕様の初期値がいくつか用意されていますが、これらはAPIゲートウェイにAPIリソースをデプロイする際に変更および拡張できます。

複数のバックエンド・サービスを定義するAPIデプロイメント仕様を使用して、APIゲートウェイへの単一のAPIデプロイメントを作成できます。

たとえば、次のAPIデプロイメント仕様では、OCI Functionsの単純なHello Worldサーバーレス・ファンクションを1つのバックエンドとして定義し、National Weather Service APIを2番目のバックエンドとして定義しています。

{
  "routes": [
    {
      "path": "/hello",
      "methods": ["GET"],
      "backend": {
        "type": "ORACLE_FUNCTIONS_BACKEND",
        "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
      }
    },
    {
      "path": "/weather",
      "methods": ["GET"],
      "backend": {
        "type": "HTTP_BACKEND",
        "url": "https://api.weather.gov"
      }
    }
  ]
}