Creazione di una specifica di distribuzione API

Per creare una specifica di distribuzione API durante la creazione di una distribuzione API utilizzando le finestre di dialogo nella console, vedere Utilizzo della console per creare una distribuzione API da zero.

Per creare una specifica di distribuzione API in un file JSON, effettuare le operazioni riportate di seguito.

1. Utilizzando l'editor JSON preferito, creare la specifica di distribuzione API in un file JSON nel formato seguente:

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

   dove:

   • "requestPolicies" specifica i criteri facoltativi per controllare il funzionamento di una distribuzione API. Se si desidera applicare i criteri a tutti gli instradamenti in una specifica di distribuzione API, posizionarli all'esterno della sezione routes. Se si desidera applicare i criteri solo a un instradamento specifico, inserire i criteri nella sezione routes. Vedere Aggiunta di criteri di richiesta e di risposta alle specifiche di distribuzione API.

   • <api-route-path> specifica un percorso per le chiamate API utilizzando i metodi elencati per il servizio backend. Tenere presente che il percorso di instradamento specificato è il seguente:

     • è relativo al prefisso del percorso di distribuzione (vedere Distribuzione di un'API in un gateway API mediante la creazione di una distribuzione API)
     • deve essere preceduta da una barra ( / ) e può essere solo la singola barra
     • può contenere più barre in avanti (a condizione che non siano adiacenti) e può terminare con una barra in avanti
     • può includere caratteri alfanumerici maiuscoli e minuscoli
     • può includere i caratteri speciali $ - _ . + ! * ' ( ) , % ; : @ & =
     • può includere parametri e caratteri jolly (vedere Aggiunta di parametri di percorso e caratteri jolly ai percorsi di instradamento)
   • <method-list> specifica uno o più metodi accettati dal servizio backend, separati da virgole. Ad esempio, "GET, PUT".
   • <backend-type> specifica il tipo di servizio backend. I valori validi sono ORACLE_FUNCTIONS_BACKEND, HTTP_BACKEND e STOCK_RESPONSE_BACKEND.
   • <backend-target> e <identifier> specificano il servizio backend. I valori validi per <backend-target> e <identifier> dipendono dal valore di <backend-type>, come indicato di seguito.
     • Se si imposta <backend-type> su ORACLE_FUNCTIONS_BACKEND, sostituire <backend-target> con functionId e <identifier> con l'OCID della funzione. Ad esempio, "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab5b...". Vedere Aggiunta di una funzione nelle funzioni OCI come backend del gateway API.
     • Se si imposta <backend-type> su HTTP_BACKEND, sostituire <backend-target> con url e <identifier> con l'URL del servizio backend. Ad esempio, "url": "https://api.weather.gov". Vedere Aggiunta di un URL HTTP o HTTPS come backend del gateway API.
     • Se si imposta <backend-type> su STOCK_RESPONSE_BACKEND, sostituire <backend-target> e <identifier> con le coppie chiave-valore appropriate. Vedere Aggiunta di risposte scorte come backend del gateway API.

   Ad esempio, la seguente specifica di distribuzione API di base definisce una semplice funzione serverless Hello World in Funzioni OCI come un singolo backend:

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

   Per un esempio più complesso che definisce più backend, vedere Specifica di distribuzione API di esempio con più backend.

2. Salvare il file JSON contenente la specifica di distribuzione API.

3. Utilizzare la specifica di distribuzione API quando si crea o si aggiorna una distribuzione API nei modi riportati di seguito.

   • specificando il file JSON nella console quando si seleziona l'opzione Carica un'interfaccia API esistente
   • specificando il file JSON in una richiesta all'API REST del gateway API

   Per ulteriori informazioni, vedere Distribuzione di un'interfaccia API in un gateway API mediante la creazione di una distribuzione API.

Per creare una specifica di distribuzione API basata su un file di descrizione API caricato per una risorsa API, vedere Creazione di una risorsa API con una descrizione API

Il file di descrizione API fornisce alcuni valori iniziali per la specifica di distribuzione API, che è possibile modificare ed estendere durante la distribuzione della risorsa API in un gateway API.

Puoi creare una singola distribuzione API su un gateway API, con una specifica di distribuzione API che definisce più servizi backend.

Ad esempio, la seguente specifica di distribuzione API definisce una semplice funzione serverless Hello World in OCI Functions come backend e l'API National Weather Service come secondo 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"
      }
    }
  ]
}