Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
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.
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.
Se crea cuando subes una definición de API a API Gateway. Cada vez que subas una definición de API, API Gateway creará una configuración de API nueva. Es decir, puedes crear una configuración de API, pero no puedes modificarla más adelante. Si más adelante editas la definición de la API y, luego, la subes, crearás una nueva configuración de 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 la URL del servicio de backend, el formato de datos de los datos que se pasan en una solicitud, el formato de datos 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.
Una aplicación cliente pasa un código cuando llama a una API. Las claves de API identifican la aplicación o el Google Cloud proyecto que realiza la llamada a la API. Consulta Por qué y cuándo usar las claves de API para obtener más información sobre cómo usar una clave de API con tu API de API Gateway.
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.
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.
Un proxy escalable de alto rendimiento basado en Envoy que aloja la configuración de la API implementada. Cuando creas una puerta de enlace, se crea la URL externa que usan tus clientes de API para acceder a la API. Una puerta de enlace solo aloja una sola configuración de API. No puedes implementar varias configuraciones de API en la misma puerta de enlace.
Un token web JSON (JWT) que contiene los campos de 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.
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.
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.
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.
Un archivo en formato YAML o JSON que se usa para describir tu API.
Este archivo también se conoce como definición de API.
Cuando se sube a API Gateway, el documento de OpenAPI se convierte en una configuración de API.
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-08 (UTC)"],[[["\u003cp\u003eThis page provides definitions and links to further information for terms used within the API Gateway documentation.\u003c/p\u003e\n"],["\u003cp\u003eAPI definitions, created using OpenAPI or gRPC configurations, specify backend service URLs, data formats, and authentication mechanisms, among other options.\u003c/p\u003e\n"],["\u003cp\u003eAn API config is created each time an API definition is uploaded to API Gateway and is not modifiable, requiring a new upload for any edits.\u003c/p\u003e\n"],["\u003cp\u003eGateways, which are Envoy-based proxies, host a deployed API config and provide the external URL that clients use to access the API, with each gateway supporting only one API config.\u003c/p\u003e\n"],["\u003cp\u003eAPI keys are codes used by client applications to identify themselves or their Google Cloud project when calling an API.\u003c/p\u003e\n"]]],[],null,["# Glossary\n========\n\nThis page provides brief definitions and links to more information of terms\nthat are used in the API Gateway documentation.\n\nAPI\n: A REST interface that makes it easy for one application to consume capabilities or data from another application. By defining stable, simple, and well-documented entry points, APIs enable developers to easily access and reuse application logic built by other developers.\n\nAPI config\n: Created when you upload an [API definition](#api_definition) to API Gateway. Each time you upload an API definition, API Gateway creates a new API config. That is, you can create an API config but you cannot later modify it. If you later edit the API definition, and then upload the edited API definition, you create a new API config.\n\nAPI definition\n: An [Open API 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) spec\n or [gRPC](http://www.grpc.io) configuration used to create an [API config](#api_config). An API definition specifies: the URL of the backend service, the data format of data passed on a request, the data format of any data returned by the service, the authentication mechanism used to control access to the service, and many more options.\n\nAPI key\n: A code passed in by a client application when it calls an API. API\n keys identify the application or the Google Cloud project making\n the call to the API. See\n [Why and when to use API keys](/endpoints/docs/openapi/when-why-api-key)\n for more information on using an API key with your API Gateway API.\n\nAuth0\n: A service that lets you define how users authenticate to applications. See\n [Auth0](https://auth0.com) for more information.\n\nCORS\n: Cross-Origin Resource Sharing (CORS) is a specification that provides a way\n for web applications to access resources on a server in another domain\n (technically, in another origin). To learn more about CORS, see the\n [Mozilla Developer Network (MDN) web docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)\n and the [Fetch Living Standard](https://fetch.spec.whatwg.org/).\n\nFirebase authentication\n: Google's authentication service that supports end user sign-in for client\n applications by using credentials from popular federated identity providers\n such as Google, Facebook, or Twitter. See\n [Firebase authentication](https://firebase.google.com/docs/auth/)\n for more information.\n\nGateway\n: An [Envoy](https://www.envoyproxy.io/docs/envoy/latest/)-based, high-performance, scalable proxy that hosts the deployed [API config](#api_config). Creating a gateway creates the external facing URL that your API clients use to access the API. A gateway only host a single API config. You cannot deploy multiple API configs to the same gateway.\n\nGoogle ID token\n: A JSON Web Token (JWT) that contains the\n [OpenID Connect](https://developers.google.com/identity/protocols/OpenIDConnect)\n fields needed to identify a Google user account or service account, and that\n is signed by Google's authentication service, `https://accounts.google.com`.\n\ngRPC\n: A high performance, open source universal RPC framework developed by Google.\n In gRPC, a client application can directly call methods on a server application\n on a different machine as if it was a local object. See\n [gRPC Overview](/api-gateway/docs/grpc-overview)\n for information on using gRPC with API Gateway and the\n [gRPC](http://www.grpc.io)\n website for general information.\n\nJWT\n: JSON Web Token is an open standard access token format for use in HTTP\n Authorization headers and URI query parameters.\n See [Introduction to JSON Web Tokens](https://jwt.io/introduction/)\n for general information.\n\nOpenAPI\n: The [Open API Initiative](http://openapis.org) is an industry-wide effort to\n standardize the description of REST APIs. APIs that are described with the\n [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) (formerly\n the [Swagger Specification](http://swagger.io)) can be supported with common\n tools that create documentation, automate testing, and generate code for clients\n and servers. See [OpenAPI overview](/api-gateway/docs/openapi-overview)\n for more information.\n\nOpenAPI document\n: A file in either YAML or JSON format that you use to describe your API.\n This file is also referred to as an [API definition](#api_definition).\n When uploaded to API Gateway, the OpenAPI document is converted to an [API config](#api_config).\n\nSurface\n: The public interface of an [API](#api_def). An API's surface consists of the methods\n as well as the parameters and return types used in the methods."]]
