Glossário
Esta página fornece definições breves e links para mais informações sobre os termos usados na documentação do API Gateway.
- API
- 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.
- Configuração da API
- 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.
- Definiçã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.
- Chave da API
- 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.
- Auth0
- Um serviço que lhe permite definir como os utilizadores se autenticam nas aplicações. Consulte o artigo Auth0 para mais informações.
- CORS
- 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.
- Firebase Authentication
- 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.
- Gateway
- 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.
- Token de ID da Google
- 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
. - gRPC
- 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.
- JWT
- 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.
- OpenAPI
- 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.
- Documento OpenAPI
- 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.
- Superfície
- A interface pública de uma API. A superfície de uma API consiste nos métodos, bem como nos parâmetros e nos tipos de retorno usados nos métodos.