API-Deployment-Spezifikation erstellen

Um eine API-Deployment-Spezifikation zu erstellen, während Sie ein API-Deployment mit Dialogfeldern in der Konsole erstellen, gehen Sie zu Mit der Konsole ein völlig neues API-Deployment erstellen.

So erstellen Sie eine API-Deployment-Spezifikation in einer JSON-Datei:

1. Erstellen Sie mit Ihrem bevorzugten JSON-Editor die API-Deployment-Spezifikation in einer JSON-Datei in folgendem Format:

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

   Dabei gilt:

   • "requestPolicies" gibt optionale Policys an, mit denen das Verhalten eines API-Deployments gesteuert wird. Wenn Sie Policys auf alle Routen in einer API-Deployment-Spezifikation anwenden möchten, platzieren Sie die Policys außerhalb des routes-Abschnitts. Wenn Sie Policys nur auf eine bestimmte Route anwenden möchten, platzieren Sie die Policys innerhalb des routes-Abschnitts. Siehe Anforderungs-Policys und Antwort-Policys zu API-Deployment-Spezifikationen hinzufügen.

   • <api-route-path> gibt einen Pfad zum Backend-Service für API-Aufrufe an, die die aufgeführten Methoden verwenden. Beachten Sie, dass der von Ihnen angegebene Routenpfad:

     • relativ zum Deployment-Pfadpräfix ist (siehe API durch das Erstellen eines API-Deployments in einem API-Gateway bereitstellen)
     • einen Schrägstrich ( / ) vorangestellt haben muss. Es kann nur ein einzelner Schrägstrich verwendet werden
     • mehrere Schrägstriche enthalten (sofern diese nicht aufeinander folgen) und mit einem Schrägstrich enden kann
     • alphanumerische Zeichen in Großbuchstaben und Kleinbuchstaben enthalten kann
     • die folgenden Sonderzeichen enthalten kann: $ - _ . + ! * ' ( ) , % ; : @ & =
     • Parameter und Platzhalter enthalten kann (siehe Pfadparameter und Platzhalter zu Routenpfaden hinzufügen)
   • <method-list> gibt eine oder mehrere Methoden, die vom Backend-Service akzeptiert werden, durch Komma getrennt an. Beispiel: "GET, PUT".
   • <backend-type> gibt den Typ des Backend-Service an. Gültige Werte sind ORACLE_FUNCTIONS_BACKEND, HTTP_BACKEND und STOCK_RESPONSE_BACKEND.
   • <backend-target> und <identifier> geben den Backend-Service an. Gültige Werte für <backend-target> und <identifier> hängen wie folgt vom Wert für <backend-type> ab:
     • Wenn Sie <backend-type> auf ORACLE_FUNCTIONS_BACKEND setzen, dann ersetzen Sie <backend-target> durch functionId und <identifier> durch die OCID der Funktion. Beispiel: "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab5b...". Siehe Funktion in OCI Functions als API-Gateway-Backend hinzufügen.
     • Wenn Sie <backend-type> auf HTTP_BACKEND setzen, dann ersetzen Sie <backend-target> durch url, und <identifier> durch die URL des Backend-Service. Beispiel: "url": "https://api.weather.gov". Siehe HTTP- oder HTTPS-URL als API-Gateway-Backend hinzufügen.
     • Wenn Sie <backend-type> auf STOCK_RESPONSE_BACKEND setzen, dann ersetzen Sie <backend-target> und <identifier> durch entsprechende Schlüsselwertpaare. Siehe Standardantworten als API-Gateway-Backend hinzufügen.

   Beispiel: Die folgende Basisspezifikation für das API-Deployment definiert eine einfache serverlose Hello World-Funktion in OCI Functions als einzelnes Backend:

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

   Ein komplexeres Beispiel, das mehrere Backends definiert, finden Sie unter Beispiel für eine API-Deployment-Spezifikation mit mehreren Backends.

2. Speichern Sie die JSON-Datei, die die API-Deployment-Spezifikation enthält.

3. Verwenden Sie die API-Deployment-Spezifikation, wenn Sie ein API-Deployment wie folgt erstellen oder aktualisieren:

   • Durch Angabe der JSON-Datei in der Konsole bei Auswahl der Option Vorhandene API hochladen
   • Durch Angabe der JSON-Datei in einer Anforderung an die REST-API von API-Gateway

   Weitere Informationen finden Sie unter API durch das Erstellen eines API-Deployments in einem API-Gateway bereitstellen.

Informationen zum Erstellen einer API-Deployment-Spezifikation basierend auf einer API-Beschreibungsdatei, die Sie für eine API-Ressource hochladen, finden Sie unter API-Ressource mit einer API-Beschreibung erstellen.

Die API-Beschreibungsdatei enthält einige Anfangswerte für die API-Deployment-Spezifikation, die Sie beim Bereitstellen der API-Ressource in einem API-Gateway ändern und erweitern können.

Sie können ein einzelnes API-Deployment in einem API-Gateway mit einer API-Deployment-Spezifikation erstellen, die mehrere Backend-Services definiert.

Beispiel: Die folgende API-Deployment-Spezifikation definiert eine einfache serverseitige Hello World-Funktion in OCI Functions als ein Backend und die National Weather Service-API als zweites Backend.

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