Glosario
En esta página, se proporcionan definiciones breves y vínculos para obtener más información sobre términos que se usaron en la documentación de API Gateway.
- API
- Una interfaz de REST que permite que una aplicación consuma capacidades o datos de otra aplicación con facilidad. Mediante la definición de puntos de entrada estables, simples y bien documentados, las API permiten a los desarrolladores acceder con facilidad a la lógica de aplicación que compilaron otros desarrolladores y volver a usarla.
- Configuración de API
- Se crea cuando subes una definición de API a API Gateway. Cada vez que subes una definición de API, API Gateway crea una nueva configuración de API. Es decir, puedes crear una configuración de API, pero no puedes modificarla más adelante. Si luego editas la definición de la API y, luego, subes la definición editada, crearás una nueva configuración de la API.
- Definición de la API
- Una especificación de Open API 2.0 o una configuración de gRPC que se usa para crear una configuración de API. Una definición de API especifica lo siguiente: la URL del servicio de backend, el formato de los datos que se pasan en una solicitud, el formato de los datos que muestra el servicio, el mecanismo de autenticación que se usa para controlar el acceso al servicio y muchas más opciones.
- Clave de API
- Una aplicación cliente pasa un código cuando llama a una API. Las claves de API identifican la aplicación o el proyecto de Google Cloud que realiza la llamada a la API. Consulta Por qué y cuándo usar claves de API para obtener más información sobre cómo usar una clave de API con tu API de API Gateway.
- Auth0
- Un servicio que te permite definir la manera en que los usuarios se autentican en las aplicaciones. Consulta Auth0 para obtener más información.
- CORS
- El uso compartido de recursos multiorigen (CORS) es una especificación que proporciona un modo para que las aplicaciones web accedan a los recursos de un servidor en otro dominio (de forma técnica, en otro origen). Para obtener más información sobre CORS, consulta los documentos web de Mozilla Developer Network (MDN) y el Estándar dinámico de recuperación.
- Firebase authentication
- El servicio de autenticación de Google que admite el acceso de usuarios finales a las aplicaciones cliente mediante las credenciales de proveedores de identidades federadas populares como Google, Facebook o Twitter. Consulta Firebase Authentication para obtener más información.
- Puerta de enlace
- Es un proxy escalable de alto rendimiento basado en Envoy que aloja la configuración de API implementada. Cuando se crea una puerta de enlace, se crea la URL externa que tus clientes de API utilizan para acceder a la API. Una puerta de enlace solo aloja una única configuración de API. No puedes implementar varios parámetros de configuración de API en la misma puerta de enlace.
- Token de ID de Google
- Un token web JSON (JWT) que contiene los campos OpenID Connect necesarios para identificar una cuenta de usuario o de servicio de Google, y que está firmado por el servicio de autenticación de Google,
https://accounts.google.com
. - gRPC
- Un marco de trabajo de RPC universal de código abierto y de alto rendimiento desarrollado por Google. En gRPC, una aplicación cliente puede llamar de forma directa a métodos en una aplicación del servidor en otra máquina como si fuera un objeto local. Consulta la Descripción general de gRPC para obtener información sobre el uso de gRPC con API Gateway y el sitio web de gRPC para obtener información general.
- JWT
- El token web JSON es un formato de token estándar abierto para usar en encabezados de autorización de HTTP y en parámetros de consulta de URI. Consulta Introducción a los tokens web JSON para obtener información general.
- OpenAPI
- La Open API Initiative es un esfuerzo de toda la industria para estandarizar la descripción de las API de REST. Las API descritas con Especificación de OpenAPI (antes conocida como la Especificación Swagger) es compatible con herramientas comunes que crean documentación, automatizan pruebas y generan código para clientes y servidores. Consulta la Descripción general de OpenAPI para obtener más información.
- Documento de OpenAPI
- Es un archivo en formato YAML o JSON que se usa para describir tu API. Este archivo también se conoce como una definición de API. Cuando se sube a API Gateway, el documento de OpenAPI se convierte en una configuración de API.
- Superficie
- La interfaz pública de una API. La superficie de una API consta de los métodos, los parámetros y los tipos de datos que se muestran en los métodos.