Adición de conexión como backend de API Gateway

Para agregar backends de conexión a una especificación de despliegue de API mediante la consola:

1. Cree o actualice un despliegue en la consola, seleccione la opción Crear despliegue e introduzca los detalles en la página Información básica.

   Para obtener más información, consulte Despliegue de una API en un gateway del API mediante el despliegue de un despliegue de API y Actualización de un gateway del API.

2. En la página Autenticación, especifique las opciones de autenticación:

   1. Configure una política de solicitud de autenticación de token y seleccione Punto final de introspección de OAuth 2.0 en la lista Tipo de validación.
   2. Configure una política de fallo de validación y seleccione OAuth2.0 redireccionar cliente a proveedor de identidad.
   3. Para Ruta de conexión, especifique una ruta de redireccionamiento de inicio de sesión estática, como /auth/callback.

      La ruta de redireccionamiento de conexión estática debe ser relativa al prefijo de ruta de despliegue. Por ejemplo, si el prefijo de la ruta de acceso de despliegue es /apex y la ruta de acceso de redirección de conexión estática es /auth/callback, la ruta de acceso de devolución de llamada completa es /apex/auth/callback.

   Para obtener más información sobre las opciones de autenticación, consulte Adición de autenticación y autorización a despliegues de API y Validación de tokens para agregar autenticación y autorización a despliegues de API.

3. En la página Rutas, cree una nueva ruta y especifique:

   • Ruta: ruta de redireccionamiento de conexión estática especificada en la política de fallos de validación de OAuth 2.0. Tenga en cuenta que la ruta de acceso especificada:

     • Es relativa al prefijo de ruta de acceso de despliegue.
     • debe estar precedido de una barra inclinada (/)
     • puede contener varias barras inclinadas, siempre que no sean adyacentes
     • Puede incluir caracteres alfanuméricos en mayúscula y minúscula.
     • puede incluir los caracteres especiales $ - _ . + ! ' ( ) , % ; : @ & =
     • no deben incluir parámetros de ruta de acceso ni comodines

     Tenga en cuenta que las reglas para las rutas de ruta de backend de conexión son diferentes de las reglas para las rutas de ruta de backend de desconexión.

   • Métodos: uno o varios métodos aceptados por el backend. En el caso de los backends de conexión, solo se acepta GET.

   • Agregar un único backend o agregar varios backends: si se enrutan todas las solicitudes al mismo backend o se enrutan a otros backends.

     En estas instrucciones se supone que desea utilizar un único backend, por lo que debe seleccionar Agregar un único backend. Como alternativa, si desea utilizar backends diferentes, seleccione Agregar varios backends.

   • Tipo de backend: el tipo de servicio de backend es Conexión.

4. Seleccione Crear para crear la ruta.

5. Seleccione Siguiente para revisar los detalles que ha introducido para el despliegue API.

6. Seleccione Crear o Actualizar para crear o actualizar el despliegue de API.

7. Configure el proveedor de identidad para que incluya la URL de devolución de llamada completa como una URL de redirección válida.

   La URL de devolución de llamada completa incluye el nombre de host del gateway de API, el prefijo de ruta de despliegue y la ruta de redireccionamiento de conexión estática. Por ejemplo:

   https://<gateway-hostname>/<deployment-path-prefix>/auth/callback

   Tenga en cuenta que si el prefijo de ruta de despliegue es simplemente / y la ruta de redireccionamiento de conexión estática es /auth/callback, la URL de devolución de llamada completa es https://<gateway-hostname>/auth/callback (y no https://<gateway-hostname>//auth/callback).

8. De manera opcional, confirme que la API Se ha desplegado correctamente llamándola.

Para agregar backends de conexión a una especificación de despliegue de API en un archivo JSON:

1. Con su editor JSON preferido, edite la especificación que desea agregar un backend de conexión o cree una nueva especificación que desea desplegar de API.

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

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

2. En la sección routes, incluya una nueva sección para un backend de conexión:

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         }
       },
       {
         "path": "<login-route-path>",
         "methods": ["<method-list>"],
         "backend": {
           "type": "OAUTH2_LOGIN_BACKEND"
         }
       }
     ]
   }

   donde:

   • <login-route-path> especifica la ruta de acceso para las redirecciones del proveedor de identidad al backend de conexión. La ruta debe coincidir con la ruta de redireccionamiento de inicio de sesión estática configurada en la política de fallos de validación de OAuth 2.0. Tenga en cuenta que la ruta de acceso especificada:

     • Es relativa al prefijo de ruta de acceso de despliegue.
     • debe estar precedido de una barra inclinada (/)
     • puede contener varias barras inclinadas, siempre que no sean adyacentes
     • Puede incluir caracteres alfanuméricos en mayúscula y minúscula.
     • puede incluir los caracteres especiales $ - _ . + ! ' ( ) , % ; : @ & =
     • no deben incluir parámetros de ruta de acceso ni comodines

     Tenga en cuenta que las reglas para las rutas de ruta de backend de conexión son diferentes de las reglas para las rutas de ruta de backend de desconexión.

   • <method-list> especifica uno o varios métodos aceptados por el backend de conexión, separados por comas. En el caso de los backends de conexión, solo se acepta GET.

   • "type": "OAUTH2_LOGIN_BACKEND" especifica que el backend es un backend de conexión.

3. Guarde el archivo JSON que contiene la especificación del despliegue API.

4. 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 de despliegue 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 del API mediante el despliegue de un despliegue de API y Actualización de un gateway del API.

5. Configure el proveedor de identidad para que incluya la URL de devolución de llamada completa como una URL de redirección válida.

   La URL de devolución de llamada completa incluye el nombre de host del gateway de API, el prefijo de ruta de despliegue y la ruta de redireccionamiento de conexión estática. Por ejemplo:

   https://<gateway-hostname>/<deployment-path-prefix>/auth/callback

   Tenga en cuenta que si el prefijo de ruta de despliegue es simplemente / y la ruta de redireccionamiento de conexión estática es /auth/callback, la URL de devolución de llamada completa es https://<gateway-hostname>/auth/callback (y no https://<gateway-hostname>//auth/callback).

6. (Opcional) Confirme la API que se ha desplegado correctamente llamándola. Consulte Llamada a una API desplegada en un gateway de API.