Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Glossaire
Cette page fournit de brèves définitions et des liens vers des informations supplémentaires concernant les termes utilisés dans la documentation spécifique à API Gateway.
Interface REST qui permet à une application de consommer facilement les fonctionnalités ou les données d'une autre application. En définissant des points d'entrée stables, simples et bien documentés, les API permettent aux développeurs d'accéder facilement à la logique d'application créée par d'autres développeurs et de la réutiliser.
Créé lorsque vous importez une définition d'API dans API Gateway. Chaque fois que vous importez une définition d'API, API Gateway crée une configuration d'API. Autrement dit, vous pouvez créer une configuration d'API, mais vous ne pourrez pas la modifier par la suite. Si vous modifiez ultérieurement la définition de l'API, puis que vous l'importez, vous créez une nouvelle configuration d'API.
Spécification Open API 2.0 ou configuration gRPC utilisée pour créer une configuration d'API. Une définition d'API spécifie l'URL du service backend, le format des données transmises dans une requête, le format des données renvoyées par le service, le mécanisme d'authentification utilisé pour contrôler l'accès au service, ainsi que de nombreuses autres options.
Code transmis par une application cliente lors de l'appel d'une API. Les clés API identifient l'application ou le Google Cloud projet qui appelle l'API. Consultez la page Quand et pourquoi utiliser les clés API pour en savoir plus sur l'utilisation d'une clé API avec l'API API Gateway.
Service qui vous permet de définir la façon dont les utilisateurs s'authentifient auprès des applications. Consultez le site d'Auth0 pour plus d'informations.
Le partage de ressources inter-origines (CORS, Cross-Origin Resource Sharing) est une spécification qui permet aux applications Web d'accéder aux ressources d'un serveur situé dans un autre domaine (techniquement, d'une autre origine). Pour en savoir plus sur le CORS, consultez la documentation du site Web Mozilla Developer Network (MDN) et la page Fetch Living Standard.
Service d'authentification de Google compatible avec la connexion des utilisateurs finaux pour les applications clientes utilisant les identifiants fournis par les fournisseurs d'identité fédérés populaires tels que Google, Facebook et Twitter. Consultez la section Firebase Authentication pour plus d'informations.
Proxy évolutif hautes performances basé sur Envoy qui héberge la configuration de l'API déployée. La création d'une passerelle crée l'URL externe que vos clients API utilisent pour accéder à l'API. Une passerelle n'héberge qu'une seule configuration d'API. Vous ne pouvez pas déployer plusieurs configurations d'API sur la même passerelle.
Jeton Web JSON (JWT, JSON Web Token) contenant les champs OpenID Connect nécessaires à l'identification d'un compte de service ou d'un compte utilisateur Google, et qui est signé par le service d'authentification de Google, https://accounts.google.com.
Framework RPC universel Open Source hautes performances développé par Google.
gRPC permet à une application cliente d'appeler directement des méthodes dans une application serveur sur un ordinateur différent, comme s'il s'agissait d'un objet local. Consultez la section Présentation de gRPC pour en savoir plus sur l'utilisation de gRPC avec API Gateway et le site Web de gRPC pour obtenir des informations générales.
Jeton Web JSON (JWT) est un format de jeton à accès standard ouvert, à utiliser dans les en-têtes d'autorisation HTTP et les paramètres de requête URI.
Consultez la page Introduction aux jetons Web JSON pour obtenir des informations générales.
L'OpenAPI Initiative répond à une volonté conjointe des entreprises du secteur de standardiser la description des API REST. Les API décrites dans la spécification OpenAPI (anciennement spécification Swagger) sont ainsi potentiellement compatibles avec des outils courants permettant de créer de la documentation, d'automatiser les tests et de générer du code pour les clients et les serveurs. Pour en savoir plus, consultez la page Présentation d'OpenAPI.
Fichier au format YAML ou JSON que vous utilisez pour décrire votre API.
Ce fichier est également appelé définition d'API.
Lorsqu'il est importé dans API Gateway, le document OpenAPI est converti en configuration d'API.
Interface publique d'une API. La surface d'une API comprend les méthodes, ainsi que les paramètres et les types d'affichage utilisés dans les méthodes.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/03 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/03 (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."]]
