Uma interface REST que facilita o consumo de capacidades ou dados de uma aplicação por parte de outra. Ao definir pontos de entrada estáveis, simples e bem documentados, as APIs permitem que os programadores acedam e reutilizem facilmente a lógica de aplicação criada por outros programadores.
Criado quando carrega uma definição da API para o API Gateway. Sempre que carrega uma definição de API, o API Gateway cria uma nova configuração da API. Ou seja, pode criar uma configuração da API, mas não a pode modificar posteriormente. Se editar posteriormente a definição da API e, em seguida, carregar a definição da API editada, cria uma nova configuração da API.
Uma especificação da API aberta 2.0
ou uma configuração gRPC usada para criar uma configuração da API. Uma definição de API especifica: o URL do serviço de back-end, o formato de dados dos dados transmitidos num pedido, o formato de dados de quaisquer dados devolvidos pelo serviço, o mecanismo de autenticação usado para controlar o acesso ao serviço e muitas mais opções.
Um código transmitido por uma aplicação cliente quando chama uma API. As chaves da API identificam a aplicação ou o Google Cloud projeto que faz
a chamada para a API. Consulte o artigo
Porquê e quando usar chaves da API
para mais informações sobre a utilização de uma chave da API com a sua API API Gateway.
A partilha de recursos de origem cruzada (CORS) é uma especificação que oferece uma forma de as aplicações Web acederem a recursos num servidor noutro domínio (tecnicamente, noutra origem). Para saber mais sobre a CORS, consulte os
documentos Web da Mozilla Developer Network (MDN)
e a Fetch Living Standard.
O serviço de autenticação da Google que suporta o início de sessão do utilizador final para aplicações cliente através da utilização de credenciais de fornecedores de identidade federada populares, como a Google, o Facebook ou o Twitter. Consulte o artigo
Autenticação do Firebase
para mais informações.
Um proxy escalável de alto desempenho baseado no Envoy que aloja a configuração da API implementada. A criação de um gateway cria o URL externo que os clientes da API usam para aceder à API. Um gateway só pode alojar uma configuração da API. Não pode implementar várias configurações de API na mesma gateway.
Um token Web JSON (JWT) que contém os campos do
OpenID Connect
necessários para identificar uma conta de utilizador ou uma conta de serviço Google e que
é assinado pelo serviço de autenticação da Google, https://accounts.google.com.
Uma framework RPC universal de código aberto e de alto desempenho desenvolvida pela Google.
No gRPC, uma aplicação cliente pode chamar diretamente métodos numa aplicação servidor
numa máquina diferente como se fosse um objeto local. Consulte a
vista geral do gRPC
para obter informações sobre a utilização do gRPC com o API Gateway e o
gRPC
Website para informações gerais.
O símbolo da Web JSON é um formato de token de acesso padrão aberto para utilização em cabeçalhos de autorização HTTP e parâmetros de consulta URI.
Consulte o artigo Introdução aos símbolos da Web JSON
para obter informações gerais.
A Open API Initiative é um esforço de toda a indústria para
padronizar a descrição das APIs REST. As APIs descritas com a especificação OpenAPI (anteriormente, a especificação Swagger) podem ser suportadas com ferramentas comuns que criam documentação, automatizam os testes e geram código para clientes e servidores. Consulte a vista geral da OpenAPI
para mais informações.
Um ficheiro no formato YAML ou JSON que usa para descrever a sua API.
Este ficheiro também é denominado definição da API.
Quando carregado para o API Gateway, o documento OpenAPI é convertido numa configuração da API.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-19 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."]]
