Eine REST-Schnittstelle, mit der eine Anwendung problemlos Funktionen oder Daten aus einer anderen Anwendung nutzen kann. Durch die Definition von stabilen, einfachen und gut dokumentierten Einstiegspunkten können Entwickler dank APIs auf die von anderen Entwicklern erstellte Anwendungslogik zugreifen und diese wiederverwenden.
Wird erstellt, wenn Sie eine API-Definition in API Gateway hochladen. Jedes Mal, wenn Sie eine API-Definition hochladen, erstellt API Gateway eine neue API-Konfiguration. Das heißt, Sie können eine API-Konfiguration erstellen, aber später nicht mehr ändern. Wenn Sie die API-Definition später bearbeiten und dann die bearbeitete API-Definition hochladen, erstellen Sie eine neue API-Konfiguration.
Eine Open API 2.0-Spezifikation oder gRPC-Konfiguration, die zum Erstellen einer API-Konfiguration verwendet wird. Eine API-Definition gibt Folgendes an: die URL des Back-End-Dienstes, das Datenformat der Daten, die in einer Anfrage übergeben werden, das Datenformat aller vom Dienst zurückgegebenen Daten, den Authentifizierungsmechanismus zur Steuerung des Zugriffs auf den Dienst und viele weitere Optionen.
Ein Code, der von einer Clientanwendung beim Aufrufen einer API übergeben wird. API-Schlüssel identifizieren die Anwendung oder das Google Cloud Projekt, das den Aufruf der API durchführt. Weitere Informationen zur Verwendung eines API-Schlüssels mit Ihrer API Gateway API finden Sie unter API-Schlüssel effizient nutzen.
Cross-Origin Resource Sharing (CORS) ist eine Spezifikation, mit der Webanwendungen auf Ressourcen zugreifen können, die sich auf einem Server in einer anderen Domain (technisch betrachtet also mit anderer Herkunft) befinden. Weitere Informationen zu CORS finden Sie in den Webdokumenten für Mozilla Developer Network (MDN) und unter Fetch Living Standard.
Der Authentifizierungsdienst von Google, der die Endnutzeranmeldung für Clientanwendungen mit Anmeldedaten von den großen föderierten Identitätsanbietern wie Google, Facebook oder Twitter unterstützt. Weitere Informationen finden Sie unter Firebase-Authentifizierung.
Ein leistungsstarker, skalierbarer Proxy, der auf Envoy basiert und die bereitgestellte API-Konfiguration hostet. Durch das Erstellen eines Gateways wird die externe URL erstellt, über die Ihre API-Clients auf die API zugreifen. Ein Gateway hostet nur eine einzelne API-Konfiguration. Es ist nicht möglich, mehrere API-Konfigurationen für dasselbe Gateway bereitzustellen.
Ein JSON Web Token (JWT), das die erforderlichen OpenID Connect-Felder zur Identifizierung eines Google-Nutzerkontos oder -Dienstkontos enthält und das vom Google-Authentifizierungsdienst https://accounts.google.com signiert ist.
Ein von Google entwickeltes allgemeines und besonders leistungsfähiges RPC-Open-Source-Framework.
In gRPC kann eine Clientanwendung Methoden in einer Serveranwendung auf einem anderen Computer direkt aufrufen, als wäre sie ein lokales Objekt. Informationen zur Verwendung von gRPC mit API Gateway finden Sie unter gRPC – Übersicht. Allgemeine Informationen finden Sie auf der gRPC-Website.
JSON Web Token ist ein Tokenformat mit offenem Standard für die Verwendung in HTTP-Autorisierungs-Headern und URI-Abfrageparametern.
Allgemeine Informationen finden Sie unter Einführung in JSON Web Tokens.
Die OpenAPI-Initiative ist eine branchenweite Initiative zur Standardisierung der Beschreibung von REST APIs. Mit der OpenAPI-Spezifikation (früher Swagger-Spezifikation) beschriebene APIs können durch gängige Tools zum Erstellen von Dokumentationen, zum Automatisieren von Tests oder zum Generieren von Code für Clients und Server unterstützt werden. Weitere Informationen finden Sie in der OpenAPI-Übersicht.
Eine Datei im YAML- oder JSON-Format, mit der Sie Ihre API beschreiben.
Diese Datei wird auch als API-Definition bezeichnet.
Beim Hochladen in API Gateway wird das OpenAPI-Dokument in eine API-Konfiguration umgewandelt.
Die öffentliche Schnittstelle einer API. Die Oberfläche einer API besteht aus den Methoden sowie den in den Methoden verwendeten Parametern und Rückgabetypen.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 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."]]
