Ajout de la prise en charge de la spécification CORS aux déploiements d'API

Pour ajouter une politique de demande CORS à une spécification de déploiement d'API à l'aide de la console :

1. Créez ou mettez à jour un déploiement d'API à l'aide de la console, sélectionnez l'option À partir de zéro et entrez les détails dans la page Informations de base.

   Pour plus d'informations, voir Déploiement d'une API sur une passerelle d'API en créant un déploiement d'API et Mise à jour d'une passerelle d'API.

2. Dans la section Politiques de demande d'API de la page informations de base, sélectionnez le bouton Ajouter à côté du champ CORS et spécifiez les données suivantes :

   • Origines autorisées : Origine autorisée à accéder au déploiement d'API. Par exemple, https://oracle.com. Sélectionnez + Autre origine pour entrer une deuxième origine et les origines suivantes.
   • Méthodes autorisées : Une ou plusieurs méthodes autorisées dans la demande réelle au déploiement d'API. Par exemple, GET, PUT.
   • En-têtes autorisés : Facultativement, un en-tête HTTP autorisé dans la demande réelle au déploiement d'API. Par exemple, opc-request-id ou If-Match. Sélectionnez + Autre en-tête pour entrer un deuxième en-tête et les en-têtes suivants.
   • En-têtes exposés : Facultativement, un en-tête HTTP auquel les clients d'API peuvent accéder dans la réponse du déploiement d'API à une demande réelle. Par exemple, ETag ou opc-request-id. Sélectionnez + Autre en-tête pour entrer un deuxième en-tête et les en-têtes suivants.
   • Ancienneté maximum en secondes : Facultativement, un nombre entier indiquant pendant combien de temps (en secondes delta) les résultats d'une demande préliminaire peuvent être mis en mémoire cache par un navigateur. Si vous ne spécifiez pas de valeur, la valeur par défaut est 0.
   • Activer l'option d'autorisation des données d'identification : Indique si la demande réelle au déploiement d'API peut être effectuée à l'aide de données d'identification (témoins, en-têtes d'autorisation ou certificats de client TLS). Par défaut, cette option n'est pas sélectionnée.

   Pour découvrir comment les différents champs de la politique de demande CORS sont mappés dans les différents en-têtes de réponse CORS, voir Mappage d'une politique de demande CORS à une réponse CORS.

3. Sélectionnez Appliquer les modifications.

4. Sélectionnez Suivant pour spécifier les options d'authentification dans la page Authentification.

   Pour plus d'informations sur les options d'authentification, voir Ajout de l'authentification et de l'autorisation aux déploiements d'API.

5. Sélectionnez Suivant pour entrer les détails des routes individuelles du déploiement d'API dans la page Routes. Pour spécifier les politiques de demande CORS qui s'appliquent à une route individuelle, sélectionnez Afficher les politiques de demande de route, sélectionnez le bouton Ajouter à côté de CORS, puis spécifiez les données suivantes :

   • Origines autorisées : Origine autorisée à accéder à la route. Par exemple, https://oracle.com. Sélectionnez + Autre origine pour entrer une deuxième origine et les origines suivantes.
   • Méthodes autorisées : Une ou plusieurs méthodes autorisées dans la demande réelle à la route. Par exemple, GET, PUT.
   • En-têtes autorisés : Facultativement, un en-tête HTTP autorisé dans la demande réelle à la route. Par exemple, opc-request-id ou If-Match. Sélectionnez + Autre en-tête pour entrer un deuxième en-tête et les en-têtes suivants.
   • En-têtes exposés : Facultativement, un en-tête HTTP auquel les clients d'API peuvent accéder dans la réponse du déploiement d'API à une demande réelle. Par exemple, ETag ou opc-request-id. Sélectionnez + Autre en-tête pour entrer un deuxième en-tête et les en-têtes suivants.
   • Ancienneté maximum en secondes : Facultativement, un nombre entier indiquant pendant combien de temps (en secondes delta) les résultats d'une demande préliminaire peuvent être mis en mémoire cache par un navigateur. Si vous ne spécifiez pas de valeur, la valeur par défaut est 0.
   • Activer l'option d'autorisation des données d'identification : Indique si la demande réelle à la route peut être effectuée à l'aide de données d'identification (témoins, en-têtes d'autorisation ou certificats de client TLS). Par défaut, cette option n'est pas sélectionnée.

   Pour découvrir comment les différents champs de la politique de demande CORS sont mappés dans les différents en-têtes de réponse CORS, voir Mappage d'une politique de demande CORS à une réponse CORS.

6. Sélectionnez Appliquer les modifications, puis sélectionnez Suivant pour vérifier les détails que vous avez entrés pour le déploiement d'API et pour les routes individuelles.
7. Sélectionnez Créer ou enregistrer les modifications pour créer ou mettre à jour le déploiement d'API.
8. (Facultatif) Vérifiez que l'API a été déployée avec succès en l'appelant (voir Appel d'une API déployée sur une passerelle d'API).

Pour ajouter une politique de demande CORS à une spécification de déploiement d'API dans un fichier JSON :

1. Dans votre éditeur JSON préféré, modifiez la spécification de déploiement d'API existante à laquelle vous souhaitez ajouter la prise en charge de la spécification CORS ou créez une spécification de déploiement d'API (voir Création d'une spécification de déploiement d'API).

   Par exemple, la spécification de déploiement d'API de base suivante définit une simple fonction sans serveur Hello World du service des fonctions pour OCI en tant qu'élément dorsal unique :

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

2. Pour spécifier une politique de demande CORS qui s'applique globalement à toutes les routes d'un déploiement d'API :

   1. Insérez une section requestPolicies avant la section routes, si elle n'existe pas déjà. Par exemple :

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

   2. Ajoutez la politique cors suivante à la nouvelle section requestPolicies pour l'appliquer globalement à toutes les routes d'un déploiement d'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"
            }
          }
        ]
      }

      où :

      • "allowedOrigins": [<list-of-origins>] est une liste obligatoire séparée par des virgules contenant les origines qui sont autorisées à accéder au déploiement d'API. Par exemple, , "allowedOrigins": ["*", "https://oracle.com"].
      • "allowedMethods": [<list-of-methods>] est une liste facultative séparée par des virgules contenant les méthodes HTTP qui sont autorisées dans la demande réelle au déploiement d'API. Par exemple, "allowedMethods": ["*", "GET"].
      • "allowedHeaders": [<list-of-implicit-headers>] est une liste facultative séparée par des virgules contenant les en-têtes HTTP autorisés dans la demande réelle au déploiement d'API. Par exemple, "allowedHeaders": ["opc-request-id", "If-Match"].
      • "exposedHeaders": [<list-of-exposed-headers>] est une liste facultative séparée par des virgules contenant les en-têtes HTTP auxquels les clients d'API peuvent accéder dans la réponse du déploiement d'API à une demande réelle. Par exemple, "exposedHeaders": ["ETag", "opc-request-id"].
      • "isAllowCredentialsEnabled": <true|false> est true ou false, indiquant si la demande réelle au déploiement d'API peut être effectuée à l'aide de données d'identification (témoins, en-têtes d'autorisation ou certificats de client TLS). Si vous ne spécifiez pas de valeur, la valeur par défaut est false.
      • "maxAgeInSeconds": <seconds> est un nombre entier indiquant pendant combien de temps (en secondes delta) les résultats d'une demande préliminaire peuvent être mis en mémoire cache par un navigateur. Si vous ne spécifiez pas de valeur, la valeur par défaut est 0.

      Par exemple :

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

      Pour découvrir comment les différents champs de la politique de demande CORS sont mappés dans les différents en-têtes de réponse CORS, voir Mappage d'une politique de demande CORS à une réponse CORS.

3. Pour spécifier une politique de demande CORS qui s'applique à une route individuelle :

   1. Insérez une section requestPolicies après la section de l'élément dorsal pour la route à laquelle appliquer la politique. Par exemple :

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

   2. Ajoutez la politique cors suivante à la nouvelle section requestPolicies pour l'appliquer à cette route particulière seulement :

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

      où :

      • "allowedOrigins": [<list-of-origins>] est une liste obligatoire séparée par des virgules contenant les origines qui sont autorisées à accéder au déploiement d'API. Par exemple, , "allowedOrigins": ["*", "https://oracle.com"].
      • "allowedMethods": [<list-of-methods>] est une liste facultative séparée par des virgules contenant les méthodes HTTP qui sont autorisées dans la demande réelle au déploiement d'API. Par exemple, "allowedMethods": ["*", "GET"].
      • "allowedHeaders": [<list-of-implicit-headers>] est une liste facultative séparée par des virgules contenant les en-têtes HTTP autorisés dans la demande réelle au déploiement d'API. Par exemple, "allowedHeaders": ["opc-request-id", "If-Match"].
      • "exposedHeaders": [<list-of-exposed-headers>] est une liste facultative séparée par des virgules contenant les en-têtes HTTP auxquels les clients d'API peuvent accéder dans la réponse du déploiement d'API à une demande réelle. Par exemple, "exposedHeaders": ["ETag", "opc-request-id"].
      • "isAllowCredentialsEnabled": <true|false> est true ou false, indiquant si la demande réelle au déploiement d'API peut être effectuée à l'aide de données d'identification (témoins, en-têtes d'autorisation ou certificats de client TLS). Si vous ne spécifiez pas de valeur, la valeur par défaut est false.
      • "maxAgeInSeconds": <seconds> est un nombre entier indiquant pendant combien de temps (en secondes delta) les résultats d'une demande préliminaire peuvent être mis en mémoire cache par un navigateur. Si vous ne spécifiez pas de valeur, la valeur par défaut est 0.

      Par exemple :

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

      Pour découvrir comment les différents champs de la politique de demande CORS sont mappés dans les différents en-têtes de réponse CORS, voir Mappage d'une politique de demande CORS à une réponse CORS.

4. Enregistrez le fichier JSON contenant la spécification de déploiement d'API.

5. Utilisez comme suit la spécification de déploiement d'API lorsque vous créez ou mettez à jour un déploiement d'API :

   • En spécifiant le fichier JSON dans la console lorsque vous sélectionnez l'option Charger une API existante.
   • En spécifiant le fichier JSON dans une demande à l'API REST du service Passerelle d'API.

   Pour plus d'informations, voir Déploiement d'une API sur une passerelle d'API en créant un déploiement d'API et Mise à jour d'une passerelle d'API.

6. (Facultatif) Vérifiez que l'API a été déployée avec succès en l'appelant (voir Appel d'une API déployée sur une passerelle d'API).

Les différents champs d'une politique de demande CORS sont mappés à différents en-têtes de réponse CORS comme montré dans le tableau :