Guía de inicio rápido de API Gateway

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

1. Conéctese a la Consola como administrador del arrendamiento.
2. Abra el menú de navegación y haga clic en Identidad y seguridad. En Identidad, haga clic en Dominios.

3. Cree un grupo nuevo haciendo clic en Grupos y, a continuación, en Crear grupo.

   

4. Para crear un nuevo usuario, haga clic en Usuarios y, a continuación, en Crear usuario.

   

5. Agregue un usuario a un grupo haciendo clic en Grupos, a continuación, en el nombre del grupo y, por último, en Agregar 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 de red y recursos de gateway de API:

1. Conéctese a la Consola como administrador del arrendamiento.
2. Abra el menú de navegación y haga clic en Identidad y seguridad. En Identidad, haga clic en Compartimentos.

3. Haga clic en Crear compartimento.

   

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 del arrendamiento.
2. Abra el menú de navegación y haga clic en Identidad y seguridad. En Identidad, haga clic en 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 que los desarrolladores de API puedan acceder a recursos relacionados con gateway de API. Haga clic en Crear política, especifique un nombre y una descripción para la nueva política y seleccione el compartimento que poseerá los recursos relacionados con el gateway de API. Utilice el editor manual de Policy Builder para introducir la siguiente sentencia de política y, a continuación, haga clic en 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. Haga clic en 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 el gateway de API. Utilice el editor manual de Policy Builder para introducir la siguiente sentencia de política y, a continuación, haga clic en 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 QuickStart. Puede introducir políticas adicionales (como se describe en la documentación) para permitir que los desarrolladores de API creen despliegues de API con funciones de OCI Functions como backends, y para permitir que los gateways de API se autentiquen con un servidor de caché para recuperar 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 haga clic en Servicios para desarrolladores. En Gestión de API, haga clic en Gateways.
2. Haga clic en Crear gateway y especifique:
   • un nombre para el nuevo gateway, como acme-api-gateway
   • el tipo de nuevo gateway como Público
   • el nombre del compartimento en el que se van a crear recursos de gateway de API
   • el nombre de la VCN que se va a utilizar con el gateway de API
   • el nombre de la subred regional pública en la VCN
   
3. Haga clic en Crear.

   Cuando se haya 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 Gateways de la consola, haga clic en el nombre del gateway de API que ha creado anteriormente.
2. En Recursos, haga clic en Despliegues y, a continuación, haga clic en Crear despliegue.

3. Haga clic en Desde cero y, en la sección 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. Haga clic en Siguiente y, en la sección Ruta 1, 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, especifique el tipo como HTTP e introduzca una API pública como la URL del backend (como https://api.weather.gov).
   

5. Haga clic en Siguiente para revisar los detalles introducidos para el nuevo despliegue de API y haga clic en Crear para crearlo.

   

   Una vez que 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 la lista de despliegues de API, haga clic en 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! Ha creado su primer gateway de API y despliegue de API, y ha llamado a su primera API mediante el servicio de gateway de API.

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 y despliegues de API (consulte Listado de gateways y despliegue de API, Actualización de un gateway de API o un despliegue de API, Supresión de un gateway de API o un despliegue 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 de soporte de CORS (consulte Adding CORS support to API Deployments)
• agregación de respuestas de stock (consulte Agregación de respuestas de stock como backend de gateway de API)
• confirmación de la identidad y los permisos del emisor de llamada de API (consulte Adding Authentication and Authorization to API Deployments)

¡Ya está!