Guía de inicio rápido de API Gateway

Si aún no existen usuarios y grupos adecuados para crear y acceder a API Gateway y recursos de red:

1. Conéctese a la consola como administrador de arrendamiento.
2. Abra el menú de navegación y seleccione Identidad y seguridad. En Identidad, seleccione Dominios.

3. Seleccione un dominio y, en el separador Gestión de usuarios, cree un nuevo grupo seleccionando Crear grupo en la sección Grupos.

4. En el separador Gestión de usuarios, cree un nuevo usuario seleccionando Crear en la sección Usuarios.

5. En el separador Gestión de usuarios, agregue un usuario a un grupo seleccionando el nombre del grupo en la sección Grupos, seleccionando el separador Usuarios y, a continuación, seleccionando Asignar usuario a grupo.

Consulte instrucciones detalladas para obtener más información.

Si aún no existe un compartimento adecuado en el que crear recursos y recursos de red de API Gateway:

1. Conéctese a la consola como administrador de arrendamiento.
2. Abra el menú de navegación y seleccione Identity & Security. En Identidad, seleccione Compartimentos.

3. Seleccione Create Compartment.

Consulte instrucciones detalladas para obtener más información.

Para garantizar una alta disponibilidad, solo puede crear puertas de enlace de API en las subredes regionales (no en las específicas de dominio de disponibilidad). Si aún no existe una VCN adecuada con una subred regional pública en la que crear recursos de red:

Consulte instrucciones detalladas para obtener más información.

Si uno o más desarrolladores de API no son administradores de arrendamiento:

1. Conéctese a la consola como administrador de arrendamiento.
2. Abra el menú de navegación y seleccione Identity & Security. En Identidad, seleccione Políticas.

3. Cree políticas para otorgar acceso a los desarrolladores de API:

   1. Cree una política con una sentencia de política para permitir a los desarrolladores de API acceder a los recursos relacionados con API Gateway. Seleccione Crear política, especifique un nombre y una descripción para la nueva política y seleccione el compartimento que será el propietario de los recursos relacionados con API Gateway. Utilice el Editor Manual del Creador de Políticas para introducir la siguiente sentencia de política y, a continuación, seleccione Crear:

      Allow group <group-name> to manage api-gateway-family in compartment <compartment-name>

   2. Cree una política con una sentencia de política para permitir a los desarrolladores de API acceder a los recursos de red. Seleccione Crear política, especifique un nombre y una descripción para la nueva política y seleccione el compartimento que posee los recursos de red que se van a utilizar con API Gateway. Utilice el Editor Manual del Creador de Políticas para introducir la siguiente sentencia de política y, a continuación, seleccione Crear:

      Allow group <group-name> to manage virtual-network-family in compartment <compartment-name>

   Nota: Las políticas anteriores son suficientes para permitirle crear un despliegue de API con un backend HTTP, como se sugiere en esta guía de inicio rápido. Puede introducir políticas adicionales (como se describe en la documentación) para permitir a los desarrolladores de API crear despliegues de API con funciones de OCI Functions como backend y para permitir que los gateways de API se autentiquen con un servidor de caché para recuperar los datos de respuesta almacenados en caché.

Consulte instrucciones detalladas para obtener más información.

1. Conéctese a la consola como desarrollador de gateway de API, abra el menú de navegación y seleccione Servicios para desarrolladores. En Gestión de API, seleccione Gateways.
2. Seleccione Crear gateway y especifique:
   • un nombre para el nuevo gateway, como acme-api-gateway
   • el nombre del compartimento en el que se crearán los recursos de API Gateway
   • el tipo del nuevo gateway como Público
   • el nombre de la VCN que se utilizará con el gateway de API
   • el nombre de la subred regional pública en la VCN
   
3. Haga clic en Crear.

   Una vez creado el nuevo gateway de API, se muestra como Activo en la lista de la página Gateways.

Consulte instrucciones detalladas para obtener más información.

1. En la página de lista Gateways de la consola, seleccione el nombre del gateway de API que ha creado anteriormente.
2. En el separador Despliegues, seleccione Crear despliegue.

3. En la página Información básica, especifique:

   • un nombre para el nuevo despliegue de API, como acme-api-deployment
   • un prefijo de ruta de acceso para agregar a la ruta de acceso de cada ruta incluida en el despliegue de API, como /v1
   • el compartimento en el que se va a crear el nuevo despliegue de API

4. Seleccione Siguiente para mostrar la página Autenticación. A continuación, seleccione Siguiente para mostrar la página Rutas, seleccione Agregar ruta y especifique:

   • una ruta de acceso, como /hello
   • un método aceptado por el servicio de backend, como GET
   • el tipo de servicio de backend y los detalles asociados. Para mayor comodidad, agregue un único backend, especifique el tipo como HTTP e introduzca una API pública como la URL del backend (como https://api.weather.gov).

5. Seleccione Crear para crear la ruta. Seleccione Siguiente para revisar los detalles que ha introducido para el nuevo despliegue de API y seleccione Crear para crearlo.

   Cuando se ha creado el nuevo despliegue de API, se muestra como Activo en la lista de despliegues de API.

6. Cuando el despliegue de API esté activo, pase a la siguiente tarea.

Consulte instrucciones detalladas para obtener más información.

1. En el separador Despliegues de la página de detalles del gateway de API, seleccione el nuevo despliegue de API que acaba de crear y seleccione Copiar junto al punto final del nuevo despliegue de API que acaba de crear para copiar el punto final.

2. Abra una ventana de terminal y llame a la API introduciendo:

   curl -k -X GET <deployment-endpoint>

   donde <deployment-endpoint> es el punto final que ha copiado en el paso anterior. Por ejemplo, https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/v1/hello

Felicidades! Acaba de crear su primer gateway de API y despliegue de API, y llamó a su primera API mediante el servicio API Gateway.

Consulte instrucciones detalladas para obtener más información.

Ahora que ha creado, desplegado y llamado a una función de API, aprenda a:

• Gestión de gateways de API y despliegues de API (consulte Lista de gateways de API, Actualización de un gateway de API y Supresión de un gateway de API)
• Limitación del número de solicitudes (consulte Limitación del número de solicitudes para backends de gateway de API)
• Agregación del soporte del CORS (consulte Agregación del soporte del CORS a despliegues de API)
• Agregación de respuestas de stock (consulte Agregación de respuestas de stock como backend de puerta de enlace de API)
• confirmación de la identidad y los permisos del emisor de llamada de API (consulte Adición de autenticación y autorización a despliegues de API)

¡Ya está!