Aggiunta del supporto CORS alle distribuzioni API

Per aggiungere un criterio di richiesta CORS a una specifica di distribuzione API utilizzando la console, effettuare le operazioni riportate di seguito.

1. Creare o aggiornare una distribuzione API utilizzando la console, selezionare l'opzione Crea distribuzione e immettere i dettagli nella pagina Informazioni di base.

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

2. Nella sezione Criteri richieste API della pagina Informazioni di base, selezionare il pulsante Aggiungi accanto a CORS e specificare quanto segue.

   • Origini: un'origine a cui è consentito accedere alla distribuzione API. Ad esempio, https://oracle.com. Selezionare Altra origine per immettere la seconda origine e le origini successive.
   • Metodi: uno o più metodi consentiti nella richiesta effettiva alla distribuzione API. Ad esempio, GET, PUT.
   • Intestazioni: facoltativamente, un'intestazione HTTP consentita nella richiesta effettiva alla distribuzione dell'API. Ad esempio, opc-request-id o If-Match. Selezionare Altra intestazione per immettere la seconda e le intestazioni successive.
   • Intestazioni esposte: facoltativamente, un'intestazione HTTP a cui i client API possono accedere nella risposta della distribuzione API a una richiesta effettiva. Ad esempio, ETag o opc-request-id. Selezionare Altra intestazione per immettere la seconda e le intestazioni successive.
   • Età massima in secondi: facoltativamente, un valore intero che indica per quanto tempo (in secondi delta) i risultati di una richiesta preliminare possono essere inseriti nella cache da un browser. Se non si specifica un valore, l'impostazione predefinita è 0.
   • Abilita credenziali di autorizzazione: indica se la richiesta effettiva alla distribuzione dell'API può essere effettuata utilizzando le credenziali (cookie, intestazioni di autorizzazione o certificati client TLS). Per impostazione predefinita, questa opzione non è selezionata.

   Per informazioni su come i diversi campi del criterio di richiesta CORS vengono mappati su intestazioni di risposta CORS diverse, vedere Modalità di mapping di un criterio di richiesta CORS a una risposta CORS.

3. Selezionare Aggiorna.

4. Selezionare Avanti per specificare le opzioni di autenticazione nella pagina Autenticazione.

   Per ulteriori informazioni sulle opzioni di autenticazione, vedere Aggiunta di autenticazione e autorizzazione alle distribuzioni API.

5. Selezionare Successivo per immettere i dettagli dei singoli instradamenti nella distribuzione API nella pagina Cicli. Per specificare i criteri di richiesta CORS che si applicano a un singolo instradamento, selezionare Mostra criteri di richiesta instradamento, selezionare il pulsante Aggiungi accanto a CORS e specificare:

   • Origine: un'origine a cui è consentito accedere all'instradamento. Ad esempio, https://oracle.com. Selezionare Altra origine per immettere la seconda origine e le origini successive.
   • Metodi: uno o più metodi consentiti nella richiesta effettiva all'instradamento. Ad esempio, GET, PUT.
   • Intestazioni: facoltativamente, un'intestazione HTTP consentita nella richiesta effettiva all'instradamento. Ad esempio, opc-request-id o If-Match. Selezionare Altra intestazione per immettere la seconda e le intestazioni successive.
   • Intestazioni esposte: facoltativamente, un'intestazione HTTP a cui i client API possono accedere nella risposta della distribuzione API a una richiesta effettiva. Ad esempio, ETag o opc-request-id. Selezionare Altra intestazione per immettere la seconda e le intestazioni successive.
   • Età massima in secondi: facoltativamente, un valore intero che indica per quanto tempo (in secondi delta) i risultati di una richiesta preliminare possono essere inseriti nella cache da un browser. Se non si specifica un valore, l'impostazione predefinita è 0.
   • Abilita credenziali di autorizzazione: indica se la richiesta effettiva all'instradamento può essere effettuata utilizzando le credenziali (cookie, intestazioni di autorizzazione o certificati client TLS). Per impostazione predefinita, questa opzione non è selezionata.

   Per informazioni su come i diversi campi del criterio di richiesta CORS vengono mappati su intestazioni di risposta CORS diverse, vedere Modalità di mapping di un criterio di richiesta CORS a una risposta CORS.

6. Selezionare Aggiorna, quindi Avanti per esaminare i dettagli immessi per la distribuzione API e per i singoli instradamenti.
7. Selezionare Crea o Aggiorna per creare o aggiornare la distribuzione API.
8. (Facoltativo) Confermare che l'interfaccia API è stata distribuita correttamente chiamandola (vedere Chiamata di un'interfaccia API distribuita su un gateway API).

Per aggiungere un criterio di richiesta CORS a una specifica di distribuzione API in un file JSON, effettuare le operazioni riportate di seguito.

1. Utilizzando l'editor JSON preferito, modificare la specifica di distribuzione API esistente a cui si desidera aggiungere il supporto CORS o creare una nuova specifica di distribuzione API (vedere Creazione di una specifica di distribuzione API).

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

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

2. Per specificare un criterio di richiesta CORS che si applica a livello globale a tutti gli instradamenti in una distribuzione API, effettuare le operazioni riportate di seguito.

   1. Se non esiste già, inserire una sezione requestPolicies prima della sezione routes. Ad esempio:

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

   2. Aggiungere il seguente criterio cors alla nuova sezione requestPolicies da applicare a livello globale a tutti gli instradamenti in una distribuzione API:

      {
        "requestPolicies": {
          "cors":{
            "allowedOrigins": [<list-of-origins>],
            "allowedMethods": [<list-of-methods>],
            "allowedHeaders": [<list-of-implicit-headers>],
            "exposedHeaders": [<list-of-exposed-headers>],
            "isAllowCredentialsEnabled": <true|false>,
            "maxAgeInSeconds": <seconds>
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
              "type": "ORACLE_FUNCTIONS_BACKEND",
              "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

      dove:

      • "allowedOrigins": [<list-of-origins>] è una lista di origini obbligatoria separata da virgole e consentita per l'accesso alla distribuzione API. Ad esempio, "allowedOrigins": ["*", "https://oracle.com"]
      • "allowedMethods": [<list-of-methods>] è una lista facoltativa separata da virgole di metodi HTTP consentiti nella richiesta effettiva alla distribuzione dell'API. Ad esempio, "allowedMethods": ["*", "GET"]
      • "allowedHeaders": [<list-of-implicit-headers>] è una lista facoltativa separata da virgole di intestazioni HTTP consentite nella richiesta effettiva alla distribuzione dell'API. Ad esempio, "allowedHeaders": ["opc-request-id", "If-Match"]
      • "exposedHeaders": [<list-of-exposed-headers>] è una lista facoltativa di intestazioni HTTP separate da virgole a cui i client API possono accedere nella risposta della distribuzione API a una richiesta effettiva. Ad esempio, "exposedHeaders": ["ETag", "opc-request-id"]
      • "isAllowCredentialsEnabled": <true|false> è true o false, a indicare se la richiesta effettiva alla distribuzione dell'API può essere effettuata utilizzando le credenziali (cookie, intestazioni di autorizzazione o certificati client TLS). Se non viene specificato, il valore predefinito è false.
      • "maxAgeInSeconds": <seconds> è un valore intero che indica per quanto tempo (in secondi delta) i risultati di una richiesta preliminare possono essere inseriti nella cache da un browser. Se non viene specificato, il valore predefinito è 0.

      Ad esempio:

      {
        "requestPolicies": {
          "cors":{
            "allowedOrigins": ["*", "https://oracle.com"],
            "allowedMethods": ["*", "GET"],
            "allowedHeaders": [],
            "exposedHeaders": [],
            "isAllowCredentialsEnabled": false,
            "maxAgeInSeconds": 3000
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
              "type": "ORACLE_FUNCTIONS_BACKEND",
              "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

      Per informazioni su come i diversi campi del criterio di richiesta CORS vengono mappati su intestazioni di risposta CORS diverse, vedere Modalità di mapping di un criterio di richiesta CORS a una risposta CORS.

3. Per specificare un criterio di richiesta CORS che si applica a un singolo instradamento:

   1. Inserire una sezione requestPolicies dopo la sezione backend per l'instradamento a cui si desidera applicare il criterio. Ad esempio:

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

   2. Aggiungere il seguente criterio cors alla nuova sezione requestPolicies da applicare solo a questo instradamento specifico:

      {
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
              "type": "ORACLE_FUNCTIONS_BACKEND",
              "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "requestPolicies": {
              "cors":{
                 "allowedOrigins": [<list-of-origins>],
                 "allowedMethods": [<list-of-methods>],
                 "allowedHeaders": [<list-of-implicit-headers>],
                 "exposedHeaders": [<list-of-exposed-headers>],
                 "isAllowCredentialsEnabled": <true|false>,
                 "maxAgeInSeconds": <seconds>
              }
            }
          }
        ]
      }

      dove:

      • "allowedOrigins": [<list-of-origins>] è una lista di origini obbligatoria separata da virgole e consentita per l'accesso alla distribuzione API. Ad esempio, "allowedOrigins": ["*", "https://oracle.com"]
      • "allowedMethods": [<list-of-methods>] è una lista facoltativa separata da virgole di metodi HTTP consentiti nella richiesta effettiva alla distribuzione dell'API. Ad esempio, "allowedMethods": ["*", "GET"]
      • "allowedHeaders": [<list-of-implicit-headers>] è una lista facoltativa separata da virgole di intestazioni HTTP consentite nella richiesta effettiva alla distribuzione dell'API. Ad esempio, "allowedHeaders": ["opc-request-id", "If-Match"]
      • "exposedHeaders": [<list-of-exposed-headers>] è una lista facoltativa di intestazioni HTTP separate da virgole a cui i client API possono accedere nella risposta della distribuzione API a una richiesta effettiva. Ad esempio, "exposedHeaders": ["ETag", "opc-request-id"]
      • "isAllowCredentialsEnabled": <true|false> è true o false, a indicare se la richiesta effettiva alla distribuzione dell'API può essere effettuata utilizzando le credenziali (cookie, intestazioni di autorizzazione o certificati client TLS). Se non viene specificato, il valore predefinito è false.
      • "maxAgeInSeconds": <seconds> è un valore intero che indica per quanto tempo (in secondi delta) i risultati di una richiesta preliminare possono essere inseriti nella cache da un browser. Se non viene specificato, il valore predefinito è 0.

      Ad esempio:

      {
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
              "type": "ORACLE_FUNCTIONS_BACKEND",
              "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "requestPolicies": {
              "cors":{
                 "allowedOrigins": ["*", "https://oracle.com"],
                 "allowedMethods": ["*", "GET"],
                 "allowedHeaders": [],
                 "exposedHeaders": [],
                 "isAllowCredentialsEnabled": false,
                 "maxAgeInSeconds": 3000
              }
            }
          }
        ]
      }

      Per informazioni su come i diversi campi del criterio di richiesta CORS vengono mappati su intestazioni di risposta CORS diverse, vedere Modalità di mapping di un criterio di richiesta CORS a una risposta CORS.

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

5. 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'API di distribuzione 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 e Aggiornamento di un Gateway API.

6. (Facoltativo) Confermare che l'interfaccia API è stata distribuita correttamente chiamandola (vedere Chiamata di un'interfaccia API distribuita su un gateway API).

I diversi campi di una mappa dei criteri di richiesta CORS su intestazioni di risposta CORS diverse, come illustrato nella tabella: