Verwenden von Metadaten für die API-Governance
Dieser Artikel enthält Hintergrundinformationen zu Metadaten und deren Verwendung für API-Governance in Azure API Center. Sie können Metadaten zum Organisieren und Filtern von APIs und anderen Entitäten in API Center definieren und festlegen. Metadaten können integriert oder benutzerdefiniert sein, und Sie können ein Metadatenschema entwickeln, um Konsistenz zwischen Ihren APIs, Umgebungen und Bereitstellungen zu erzwingen.
Integrierte Metadaten
Beim Erstellen oder Aktualisieren von APIs, Umgebungen und Bereitstellungen in API Center legen Sie bestimmte integrierte Metadateneigenschaften fest, z. B. den API-Typ (REST, WSDL usw.).
In den folgenden Tabellen sind integrierte Metadaten aufgeführt, die für Azure API Center-Entitäten bereitgestellt werden. Ausführliche Informationen finden Sie in der REST-API-Referenz zu API Center. Tabellen enthalten keine standardmäßigen Azure-Eigenschaften wie Ressourcenbezeichner, Anzeigetitel und Beschreibungen. Nicht alle Eigenschaften sind erforderlich.
APIs
| Metadaten | Beschreibung | Beispielwerte |
|---|---|---|
| Art | Art (Typ) der API | REST, SOAP, GraphQL |
| Lebenszyklusphase | Phase des API-Entwicklungslebenszyklus | Entwurf, Entwicklung |
| license | Lizenzinformationen für die API | SPDX-Bezeichner, Link zum Lizenztext |
| externe Dokumentation | Website für die externe Dokumentation für die API | URL, die auf die Dokumentation verweist |
| Kontaktinformationen | Ansprechpartner für die API | E-Mail-Adresse, Name, URL |
| Vertragsbedingungen | Vertragsbedingungen für die API | URL, die auf die Vertragsbedingungen verweist |
Umgebungen
| Metadaten | Beschreibung | Beispielwerte |
|---|---|---|
| Art | Art (Typ) der Umgebung | Produktion, Staging, Entwicklung |
| server | Serverinformationen der Umgebung | Typ und URL, die auf den Umgebungsserver verweist |
| Servertyp | Typ des Umgebungsservers | API Management-Server, Kubernetes-Server, Apigee-Server |
| Onboarding | Onboardinginformationen für die Umgebung | Anweisungen und URL, die auf das Entwicklerportal der Umgebung verweist |
Bereitstellungen
| Metadaten | Beschreibung | Beispielwerte |
|---|---|---|
| server | Serverinformationen der Bereitstellung | URL, die auf den Bereitstellungsserver verweist |
| state | Status der Bereitstellung | aktiv, inaktiv |
Benutzerdefinierte Metadaten
Definieren Sie benutzerdefinierte Metadaten mithilfe des Azure-Portals, der REST-API von Azure API Center oder der Azure CLI, um APIs, Umgebungen und Bereitstellungen in Ihrer API Center-Instanz zu organisieren und zu filtern. Azure API Center unterstützt benutzerdefinierte Metadaten der folgenden Typen:
| Typ | Beschreibung | Beispielname |
|---|---|---|
| boolean | true oder false | IsInternal |
| Zahl | Numerischer Wert | YearOfCreation |
| Zeichenfolge | Textwert | GitHubRepository |
| array | Liste der Werte | Tags |
| integrierte Auswahlmöglichkeit | integrierte Liste der Auswahlmöglichkeiten | Abteilung |
| Objekt | komplexes Objekt, das aus mehreren Typen besteht | APIApprover |
Wichtig
Nehmen Sie keine sensiblen, vertraulichen oder personenbezogenen Informationen in die Titel (Namen) der Metadaten auf, die Sie definieren. Diese Titel sind in Überwachungsprotokollen sichtbar, die von Microsoft verwendet werden, um die Funktionalität des Diensts zu verbessern. Andere Metadatendetails und -werte sind jedoch Ihre geschützten Kundendaten.
Zuweisen von Metadaten zu Entitäten
Benutzerdefinierte Metadateneigenschaften können APIs, Umgebungen oder Bereitstellungen in API Center zugewiesen werden. Sie können beispielsweise Metadaten zur Abteilung definieren und APIs zuweisen, sodass beim Registrieren einer API oder beim Hinzufügen einer neuen API-Version die für die API zuständige Abteilung angegeben wird.
Beim Zuweisen zu einer Entität sind Metadaten optional oder erforderlich. Sie können z. B. voraussetzen, dass die Metadaten zur Abteilung nur für APIs festgelegt werden, aber YearOfCreation als optionale Metadaten für Umgebungen zulassen.
Hinweis
- Sie können jederzeit benutzerdefinierte Metadaten definieren und auf APIs und andere Entitäten in Ihrer API Center-Instanz anwenden.
- Nachdem Sie benutzerdefinierte Metadaten definiert haben, können Sie deren Zuweisung zu einer Entität ändern, z. B. von erforderlich in optional für APIs.
- Sie können Metadatenwerte ändern, aber sie können den Typ von benutzerdefinierten Metadaten, die derzeit in APIs, Umgebungen und Bereitstellungen festgelegt sind, nicht löschen oder ändern. Heben Sie zuerst die Zuweisung benutzerdefinierter Metadaten zu den Entitäten auf. Anschließend können Sie sie löschen oder ändern.
Verwenden von Metadaten für Governance
Verwenden Sie integrierte und benutzerdefinierte Metadaten, um Ihre APIs, Umgebungen und Bereitstellungen in API Center zu organisieren. Zum Beispiel:
Erzwingen Sie Governancestandards in Ihrer Organisation, indem Sie das Festlegen bestimmter Metadaten für APIs, Umgebungen und Bereitstellungen vorschreiben.
Suchen und filtern Sie APIs in Ihrer API Center-Instanz anhand von Metadatenwerten. Sie können direkt auf der Seite „APIs“ im Azure-Portal filtern oder die Azure API Center-REST-API oder die Azure CLI verwenden, um APIs basierend auf den Werten bestimmter Metadaten abzufragen.
