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.
- API
- 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.
- Configuration d'API
- Créé lorsque vous importez une définition d'API sur 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, par la suite, vous modifiez la définition d'API, puis importez la définition modifiée, vous créerez une autre configuration d'API.
- Définition d'API
- Spécification Open API 2.0 ou configuration gRPC pour créer une configuration d'API. Une définition d'API spécifie l'URL du service de backend, le format des données transmises lors d'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 et bien d'autres options.
- Clé API
- Code transmis par une application cliente lors de l'appel d'une API. Les clés API identifient l'application ou le projet Google Cloud 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.
- Auth0
- 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.
- CORS
- 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.
- Firebase Authentication
- 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.
- Passerelle
- Proxy évolutif hautes performances basé sur Envoy qui héberge la configuration d'API déployée. La création d'une passerelle entraîne la création de 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 d'identifiant Google
- 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
. - gRPC
- 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 présentation de gRPC pour en savoir plus sur l'utilisation de gRPC avec API Gateway, et le site Web de gRPC pour des informations générales.
- JWT
- 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 to JSON Web Tokens pour obtenir des informations générales.
- OpenAPI
- 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.
- Document OpenAPI
- Fichier au format YAML ou JSON que vous utilisez pour décrire votre API. Ce fichier est également appelé définition d'API. Une fois importé dans API Gateway, le document OpenAPI est converti en configuration d'API.
- Surface
- Interface publique d'une API. La surface d'une API comprend les méthodes, ainsi que les paramètres et les types renvoyés utilisés dans ces méthodes.