Creación de una especificación de despliegue de API

Para crear una especificación de despliegue de API mientras crea un despliegue de API mediante cuadros de diálogo en la consola, consulte Uso de la consola para crear un despliegue de API desde cero.

Siga estos pasos para crear una especificación de despliegue de API en un archivo JSON:

1. Con su editor de JSON preferido, cree la especificación de despliegue API en un archivo JSON con el formato:

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

   donde:

   • "requestPolicies" especifica políticas opcionales para controlar el comportamiento de un despliegue de API. Si desea aplicar políticas a todas las rutas de una especificación de despliegue de API, coloque las políticas fuera de la sección routes. Si desea aplicar las políticas únicamente a una ruta concreta, coloque las políticas en la sección routes. Consulte Agregación de políticas de solicitud y políticas de respuesta a especificaciones de despliegue de API.

   • <api-route-path> especifica una ruta de acceso al servicio de backend para las llamadas de API mediante los métodos enumerados. Tenga en cuenta que la ruta de acceso especificada:

     • Es relativa al prefijo de ruta de acceso de despliegue (consulte Despliegue de una API en un gateway de API mediante la creación de un despliegue de API).
     • Debe estar precedida de una barra inclinada (/) y puede ser simplemente esa barra inclinada.
     • Puede contener varias barras inclinadas (siempre que no sean adyacentes) y puede terminar con una barra inclinada.
     • Puede incluir caracteres alfanuméricos en mayúscula y minúscula.
     • Puede incluir los caracteres especiales $ - _ . + ! * ' ( ) , % ; : @ & = .
     • Puede incluir parámetros y comodines (consulte Agregación de parámetros de ruta y comodines a rutas de acceso).
   • <method-list> especifica uno o varios métodos aceptados por el servicio de backend, separados por comas. Por ejemplo, "GET, PUT".
   • <backend-type> especifica el tipo de servicio de backend. Los valores válidos son ORACLE_FUNCTIONS_BACKEND, HTTP_BACKEND y STOCK_RESPONSE_BACKEND.
   • <backend-target> y <identifier> especifican el servicio de backend. Los valores válidos para <backend-target> y <identifier> dependen del valor de <backend-type>, como se indica a continuación:
     • Si establece <backend-type> en ORACLE_FUNCTIONS_BACKEND, sustituya <backend-target> por functionId y reemplace <identifier> por el OCID de la función. Por ejemplo, "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab5b...". Consulte Agregación de una función en OCI Functions como backend de gateway de API.
     • Si define <backend-type> en HTTP_BACKEND, sustituya <backend-target> por url y reemplace <identifier> por la URL del servicio de backend. Por ejemplo, "url": "https://api.weather.gov". Consulte Agregación de una URL de HTTP o HTTPS como backend de gateway de API.
     • Si define <backend-type> en STOCK_RESPONSE_BACKEND, sustituya <backend-target> y <identifier> por pares clave-valor adecuados. Consulte Agregación de respuestas de stock como backend de gateway de API.

   Por ejemplo, la siguiente especificación de despliegue de API básico define una función sencilla de Hello World sin servidor en OCI Functions como un único backend:

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

   Para ver un ejemplo más complejo en el que se definen varios backends, consulte Especificación de despliegue de API con varios backends de ejemplo.

2. Guarde el archivo JSON que contiene la especificación de despliegue de API.

3. Utilice la especificación de despliegue de API al crear o actualizar un despliegue de API de las siguientes formas:

   • Especificando el archivo JSON en la consola al seleccionar la opción Cargar API existente.
   • Especificando el archivo JSON en una solicitud para la API REST de gateway de API.

   Para obtener más información, consulte Despliegue de una API en un gateway de API mediante la creación de un despliegue de API.

Para crear una especificación de despliegue de API basada en un archivo de descripción de la API que cargue para un recurso de API, consulte Creación de un recurso de API con una descripción de la API

El archivo de descripción de la API proporciona algunos valores iniciales para la especificación de despliegue de API, que puede modificar y ampliar al desplegar el recurso de API en un gateway de API.

Puede crear un único despliegue de API en un gateway de API, con una especificación de despliegue de API que defina varios servicios de backend.

Por ejemplo, la siguiente especificación de despliegue de API define una función sencilla de Hello World sin servidor en OCI Functions como backend, y la API de National Weather Service como segundo 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"
      }
    }
  ]
}