Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Diese Seite gilt für Apigee und Apigee Hybrid.
Informationen zu API-Spezifikationen
API-Spezifikationen verwenden Standardformate zum Beschreiben von APIs. Sie sind maschinenlesbar, aber auch leicht für Menschen lesbar und verständlich. Spezifikationen beschreiben in der Regel Elemente einer API, darunter Basispfad, Pfade und Verben, Header, Abfrageparameter, Vorgänge, Inhaltstypen, Antwortbeschreibungen usw., wie in Abbildung 1 dargestellt.
Abbildung 1. Auszug aus einer OpenAPI-Spezifikation.
Eine API-Version kann mehrere API-Spezifikationen desselben oder unterschiedlichen Typs enthalten, z. B. OpenAPI-Spezifikation, Proto und WSDL. Falls unterstützt, kann der API-Hub eine API-Spezifikation parsen, um API-Metadaten wie die API-ID, Versions-ID, Beschreibung und Vorgänge zu extrahieren und zu speichern. Siehe Spezifikationsparsen.
API-Spezifikationen mit API-Hub verwenden
Sie können eine API-Version im API-Hub mit oder ohne API-Spezifikation erstellen.
Sie können eine Spezifikation beim Erstellen einer Version hochladen. Wenn Sie sich die Details einer API auf der Benutzeroberfläche ansehen, sehen Sie eine Liste aller Spezifikationen, die mit den Versionen einer API-Ressource verknüpft sind.
Sie können über die REST API auch eine Version mit einer Spezifikation erstellen und konfigurieren. Wenn Sie die API verwenden, erstellen Sie eine API-Versionsentität mit der Spezifikation und können dann die Version an eine API-Ressource anhängen.
Falls unterstützt, kann der API-Hub eine API-Spezifikation parsen, um Informationen zur API zu extrahieren und mit einer API-Version zu speichern. Beispielsweise kann der API-Hub eine API-OpenAPI-Spezifikation parsen, um die API-ID, die Versions-ID, die Beschreibung, Vorgänge und andere Metadaten zu extrahieren und zu speichern.
[[["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-08-07 (UTC)."],[[["\u003cp\u003eAPI specifications are standardized, machine-readable formats that describe APIs, including elements like paths, verbs, headers, and response descriptions.\u003c/p\u003e\n"],["\u003cp\u003eAPI hub allows the creation of API versions both with and without an API specification, which can be uploaded during version creation or added later using the REST API.\u003c/p\u003e\n"],["\u003cp\u003eAPI hub can parse API specifications, such as OpenAPI, to extract and store API metadata, including the API ID, version ID, description, and operations.\u003c/p\u003e\n"],["\u003cp\u003eAPI hub supports the validation of API specifications, and specification parsing is only available for OpenAPI specifications versions 2.0, 3.0 and 3.1 in both JSON and YAML formats.\u003c/p\u003e\n"]]],[],null,["# Introduction to API specifications\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\nAbout API specifications\n------------------------\n\nAPI specifications use standard formats to describe APIs. They are machine readable, but also\neasy for humans to read and understand. Specifications typically describe elements of an API\nsuch as its base path, paths and verbs, headers, query parameters, operations, content types,\nresponse descriptions, and so on, as shown in Figure 1.\n\n**Figure 1.** Excerpt from an OpenAPI specification.\n\nAn [API version](./versions-intro) can contain multiple API specifications of the same or different types such as\n[OpenAPI Spec](https://swagger.io/specification/), Proto, and WSDL. Where supported, API hub can parse an API specification to extract and store\nAPI metadata, such as the API ID, version ID, description, and operations. See [Specification parsing](#specificationparsing).\n\nUsing API specifications with API hub\n-------------------------------------\n\nYou can create an API version in API hub with or without an API specification.\n\nYou can upload a specification\nat the time you create a version. When you view details of an API in the user interface, you will\nsee a list of any specs that are associated with the versions of an API resource.\n\nYou can also create and configure a version with a specification using the REST API. When\nusing the API, you create an API version entity with the specification, then you can attach the version\nto an API resource.\n\nFor more information, see [Add a spec to a version](./manage-specifications#addspec).\n\nSpecification parsing\n---------------------\n\nWhere supported, API hub can parse an API specification to extract information about the API\nand store it with an API version. For example, API hub can parse an API OpenAPI specification to extract and store\nthe API ID, version ID, description, operations, and other metadata.\n\n\nAPI hub also supports specification validation. See [Validate an API specification](./validate-spec).\n\n| **Note:** API specification parsing is only supported for [OpenAPI specifications](https://swagger.io/specification/) (v.2.0, v3.0 and v3.1) in JSON and YAML formats."]]
