Azure API-Center – Wesentliche Konzepte
In diesem Artikel werden die wichtigsten Konzepte des Azure API Centererläutert. Das Azure API Center ermöglicht die Nachverfolgung von APIs an einem zentralen Ort für Ermittlung, Wiederverwendung und Governance.
Datenmodell
Die folgende Abbildung zeigt die wichtigsten Entitäten im Azure API Center und ihre Beziehungen untereinander. Weitere Informationen zu diesen Entitäten und verwandten Konzepten finden Sie in den nachfolgenden Abschnitten.
API
Als eine logische Entität auf oberster Ebene im Azure API Center stellt eine API jede reale API dar, die Sie nachverfolgen möchten. Im API Center können Sie APIs jeden Typs einschließen, einschließlich REST, GraphQL, gRPC, SOAP, WebSocket und Webhook.
Eine API kann von jeder API-Verwaltungslösung (z. B. Azure API Management oder Lösungen von anderen Anbietern) verwaltet werden oder nicht verwaltet sein.
Das API-Inventar im Azure API Center ist so konzipiert, dass es von API-Programmmanagern/-managerinnen oder IT-Administratoren/-Administratorinnen erstellt und verwaltet werden kann.
API-Version
Bei der API-Versionierung geht es darum, Änderungen an einer API zu verwalten und sicherzustellen, dass diese Änderungen ohne Beeinträchtigung der Clients durchgeführt werden. Eine API kann über mehrere Versionen hinweg über Lebenszyklusphasen verfügen, die jeweils an bestimmten API-Änderungen ausgerichtet sind. Einige Versionen können größere oder bahnbrechende Änderungen einführen, während andere kleinere Verbesserungen hinzufügen. Eine API-Version kann sich in jeder Lebenszyklusphase befinden – vom Entwurf bis hin zur Vorschau, Produktion oder veraltet.
API-Definition
Jede API-Version sollte idealerweise durch mindestens eine Definition definiert werden, z. B. eine OpenAPI-Definition für eine REST-API. Azure API Center erlaubt jede API-Definitionsdatei, die als Text formatiert ist (YAML, JSON, Markdown usw.). Sie können unter anderem OpenAPI-, gRPC-, GraphQL-, AsyncAPI-, WSDL- und WADL-Definitionen hochladen.
Environment
Eine Umgebung stellt einen Ort dar, an dem eine API-Laufzeit bereitgestellt werden kann, z. B. ein Azure API Management-Dienst, ein Apigee API Management-Dienst oder ein Rechendienst wie ein Kubernetes-Cluster, eine Web-App oder eine Azure-Funktion. Jede Umgebung ist auf eine Lebenszyklusphase wie Entwicklung, Test, Staging oder Produktion ausgerichtet. Eine Umgebung kann auch Informationen zu Entwicklerportal- oder Verwaltungsschnittstellen enthalten.
Hinweis
Verwenden Sie das Azure API Center, um eine Ihrer API-Laufzeitumgebungen nachzuverfolgen, unabhängig davon, ob sie in der Azure-Infrastruktur gehostet wird. Diese Umgebungen sind nicht mit Azure Deployment Environments identisch.
Bereitstellung
Eine Bereitstellung ist ein Ort (eine Adresse), an dem Benutzer auf eine API zugreifen können. Eine API kann über mehrere Bereitstellungen verfügen, z. B. unterschiedliche Stagingumgebungen oder Regionen. Beispielsweise könnte eine API eine Bereitstellung in einer internen Stagingumgebung und eine zweite in einer Produktionsumgebung haben. Jede Bereitstellung ist einer bestimmten API-Definition zugeordnet.
Metadaten
Im Azure API Center organisieren Sie Ihre APIs, Bereitstellungen und andere Entitäten, indem Sie Metadatenwerte festlegen, die zum Suchen und Filtern sowie zum Erzwingen von Governancestandards verwendet werden können. Ein API Center bietet mehrere gängige integrierte Metadateneigenschaften wie „API-Typ“ und „Lebenszyklusphase“. Personen im Besitz der API Center-Instanz können die integrierten Eigenschaften erweitern, indem sie benutzerdefinierte Eigenschaften in einem Metadatenschema definieren, um dessen APIs, Bereitstellungen und Umgebungen zu organisieren. Erstellen Sie beispielsweise eine API-genehmigende Eigenschaft, um die Person zu identifizieren, die für die Genehmigung der Verwendung einer API verantwortlich ist.
Azure API Center unterstützt Eigenschaften vom Typ Array, boolescher Wert, Zahl, Objekt, vordefinierte Optionen und Zeichenfolge.
Das Metadatenschema im Azure API Center ist mit JSON- und YAML-Schemaspezifikationen kompatibel, um die Schemaüberprüfung in Entwicklungstools und automatisierten Pipelines zu ermöglichen.