Création d'une spécification de déploiement d'API

Pour créer une spécification de déploiement d'API tout en créant un déploiement d'API à l'aide des boîtes de dialogue de la console, voir Utilisation de la console pour créer un déploiement d'API à partir de zéro.

Pour créer une spécification de déploiement d'API dans un fichier JSON :

1. Dans votre éditeur JSON préféré, créez la spécification de déploiement d'API dans un fichier JSON au format suivant :

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

   où :

   • "requestPolicies" spécifie des politiques facultatives pour contrôler le comportement d'un déploiement d'API. Si vous voulez appliquer des politiques à toutes les routes d'une spécification de déploiement d'API, placez les politiques en dehors de la section routes. Si vous voulez appliquer les politiques uniquement à une route particulière, placez les politiques dans la section routes. Voir Ajout de politiques de demande et de réponse aux spécifications de déploiement d'API.

   • <api-route-path> spécifie un chemin pour les appels d'API utilisant les méthodes indiquées au service dorsal. Notez que le chemin de routage que vous spécifiez :

     • Est relatif au préfixe du chemin du déploiement (voir Déploiement d'une API sur une passerelle d'API en créant un déploiement d'API).
     • Doit être précédé d'une barre oblique (/) et peut être simplement cette seule barre oblique.
     • Peut contenir plusieurs barres obliques (à condition qu'elles ne soient pas adjacentes) et peut se terminer par une barre oblique.
     • Peut inclure des caractères alphanumériques en majuscules et en minuscules.
     • peut inclure les caractères spéciaux $ - _ . + ! * ' ( ) , % ; : @ & =
     • Peut inclure des paramètres et des caractères génériques (voir Ajout de paramètres de chemin et de caractères génériques aux chemins de routage).
   • <method-list> spécifie une ou plusieurs méthodes acceptées par le service dorsal, séparées par des virgules. Par exemple, "GET, PUT".
   • <backend-type> spécifie le type du service dorsal. Les valeurs valides sont ORACLE_FUNCTIONS_BACKEND, HTTP_BACKEND et STOCK_RESPONSE_BACKEND.
   • <backend-target> et <identifier> spécifient le service dorsal. Les valeurs valides pour <backend-target> et <identifier> dépendent de la valeur de <backend-type>, comme suit :
     • Si vous réglez la valeur <backend type> à ORACLE_FUNCTIONS_BACKEND, remplacez <backend target> par functionId et remplacez <identifier> par l'OCID de la fonction. Par exemple, "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab5b...". Voir Ajout d'une fonction du service des fonctions pour OCI en tant qu'élément dorsal du service de passerelle d'API.
     • Si vous réglez la valeur <backend type> à HTTP_BACKEND, remplacez <backend target> par url et <identifier> par l'URL du service dorsal. Par exemple, "url": "https://api.weather.gov". Voir Ajout d'une URL HTTP ou HTTPS comme élément dorsal du service de passerelle d'API.
     • Si vous réglez la valeur <backend-type> à STOCK_RESPONSE_BACKEND, remplacez <backend-target> et <identifier> par des paires clé-valeur appropriées. Voir Ajout de réponses standard comme élément dorsal du service de passerelle 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"
         }
       }
     ]
   }

   Pour un exemple plus complexe définissant plusieurs éléments dorsaux, voir Exemple de spécification de déploiement d'API avec plusieurs éléments dorsaux.

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

3. 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.

Pour créer une spécification de déploiement d'API basée sur un fichier de description d'API que vous chargez pour une ressource d'API, voir Création d'une ressource d'API avec description de l'API

Le fichier de description d'API fournit quelques valeurs initiales pour la spécification de déploiement d'API que vous pouvez modifier et étendre lors de la création de la ressource d'API sur la passerelle d'API.

Vous pouvez créer un seul déploiement d'API sur une passerelle d'API avec une spécification de déploiement d'API qui définit plusieurs services dorsaux.

Par exemple, la spécification de déploiement d'API suivante définit une simple fonction sans serveur Hello World du service des fonctions pour OCI en tant qu'élément dorsal et l'API du service météorologique national en tant que deuxième élément dorsal.

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