Diese Seite gilt für Apigee und Apigee Hybrid.
Auf der Seite API finden Sie detaillierte Informationen zu einer API. Wenn Sie eine API auf der API-Listenseite auswählen, wird der Tab Übersicht der API-Seite angezeigt.
Der Tab Übersicht enthält die folgenden Abschnitte:
Allgemein
Im allgemeinen Bereich werden allgemeine Informationen zu einer API angezeigt, darunter:
- Anzeigename: Anzeigename für die API. Wird bei der Registrierung der API definiert. Informationen zum Bearbeiten des Anzeigenamens finden Sie unter API-Registrierungsdaten bearbeiten.
- Beschreibung: Beschreibung der API. Wird bei der Registrierung der API definiert. Informationen zum Bearbeiten der Beschreibung finden Sie unter API-Registrierungsdaten bearbeiten.
- System- und benutzerdefinierte Taxonomieelemente
- Dokumentversion: Ein Link, der die Überarbeitung öffnet, die derzeit dem Deployment zugewiesen ist. Diese Schaltfläche wird nur angezeigt, wenn ein empfohlenes Deployment vorhanden ist und diesem Deployment eine Version zugewiesen ist.
- Zugriff abrufen: Enthält Anleitungen zum Zugreifen auf diese API. Informationen zum Ändern dieser Anleitung finden Sie unter Deployment bearbeiten. Diese Schaltfläche wird nur angezeigt, wenn ein empfohlenes Deployment vorhanden ist.
Wenn unbekannte Labels oder Tags über die öffentliche API angehängt sind, werden sie in der Benutzeroberfläche nicht angezeigt. Es sind nur Labels sichtbar, die bekannte Taxonomien definieren.
Taxonomiewerten kann eine Textbeschreibung oder URL zugewiesen werden. Wenn einem Taxonomiewert eine Textbeschreibung zugewiesen ist, wird in diesem Bereich neben dem Wert das Infosymbol angezeigt. Das Bewegen des Mauszeigers über dieses Symbol blendet die Beschreibung ein. Wenn es sich bei dem Wert um eine URL handelt, wird der angezeigte Taxonomiewert zu einem Hyperlink, mit dem die URL in einem neuen Browsertab geöffnet werden kann. Weitere Informationen finden Sie unter Taxonomie hinzufügen.
API bearbeiten
Siehe API-Registrierungsdaten bearbeiten.
API löschen
Weitere Informationen finden Sie unter API löschen.
Kurzübersicht
In Übersichten sehen Teams, wie die Qualität einer API gemessen wurde. In den verschiedenen APIs wird ein durchdachter Ansatz für die Bewertung unterstützt, mit dem die Konsistenz über verschiedene Bereiche hinweg erreicht werden kann, z. B. in Bezug auf Designstandards, Sicherheitsprofile, Zuverlässigkeit oder andere für das Unternehmen wichtige Dimensionen. Im API-Hub ist bereits OpenAPI Linting konfiguriert.
Eine Kurzübersicht stellt eine Gruppe von Punktzahlen dar, die nicht einfach auf eine einzige Menge reduziert werden können.
Eine Bewertung ist ein einzelner Wert, der einen gewissen Aspekt der API-Qualität darstellt. Qualität kann in jedem Kontext definiert werden (Design, Zuverlässigkeit, Compliance usw.) und ist oft eine Frage der Meinung.
Kurzübersicht ausblenden
Informationen zum Ausblenden der Kurzübersichts-UI für jede API finden Sie unter API-Übersicht deaktivieren oder aktivieren.
Version der Kurzübersicht auswählen
Wählen Sie in der Drop-down-Liste Score diese Spezifikation die Version aus, die für die Kurzübersicht verwendet werden soll:
Wobei:
- Neueste: Diese Überarbeitungsspezifikation hat den neuesten Upload-Zeitstempel.
- Empfohlen: Dieser Spezifikation wurde eine Überarbeitung zugewiesen. Verwenden Sie diese Spezifikation, wenn Sie ein Nutzer der API sind.
Kurzübersicht anpassen
Verwenden Sie zum Anpassen und Konfigurieren der Kurzübersicht das Registry-Befehlszeilentool.
Weitere Informationen finden Sie unter Wie werden Punktzahlen berechnet?
Wenn neben den Fehlern und Warnungen in der Kurzübersicht ein Statussymbol angezeigt werden soll, definieren Sie Schwellenwerte:
Wobei:
| Typ | Symbol | Beschreibung |
|---|---|---|
| Benachrichtigung |  |
Zeigen Sie dieses Symbol an, wenn der Schwellenwert innerhalb des für Benachrichtigungen definierten Bereichs liegt. |
| Warnung |  |
Zeigen Sie dieses Symbol an, wenn der Schwellenwert innerhalb des für Warnungen definierten Bereichs liegt. |
| Ok |  |
Zeigen Sie dieses Symbol an, wenn der Schwellenwert innerhalb des für OK definierten Bereichs liegt. |
Lint-Zusammenfassung
Die Standardkonfiguration der API-Hub-Übersicht meldet Lint-Warnungen und Lint-Fehler für die Spezifikationen OpenAPI v2 und OpenAPI v3, die in den API-Hub hochgeladen wurden. API-Hub und Registry enthalten einen Standard-Linter, der auf Spectral basiert. Dieser Linter wird als Referenzbeispiel für Linting-Funktionen bereitgestellt, ohne dass Spectral selbst unterstützt werden muss. Dazu wird der OpenAPI-Regelsatz mit einigen Ausnahmen verwendet, um falsch positive Meldungen zu reduzieren. Die Erweiterung mit benutzerdefinierten Linting wird derzeit nicht unterstützt.
Eine Anleitung zum Aktualisieren der Linter-Konfiguration finden Sie in den API-Styleguides in der Registry.
Deployments
Auf dem Tab Deployments werden alle Deployments für die vom API-Editor konfigurierte API angezeigt. Deployments stellen Liveumgebungen dar, in denen die API bereitgestellt wird. Deployments sind (absteigend) nach dem Namen Umgebung sortiert. Folgende Informationen werden angezeigt:
- Umgebung
- Dokumentation
- Indikator für das empfohlene Deployment
- Gateway
- Nutzungsanleitung
- Externer Kanal
- Zugang erhalten
Weitere Informationen finden Sie unter Deployments verwalten.
Versionen
Auf dem Tab Versionen sind alle Versionen enthalten, die für die API definiert wurden. Versionen werden (absteigend) nach Versionsnummer geordnet. Folgende Informationen werden angezeigt:
- Version
- Lebenszyklusphase
- Letzte Überarbeitung
- End of Life
Weitere Informationen finden Sie unter Versionen verwalten.
Weitere Informationen
Der Bereich Weitere Informationen, der unten auf der Seite Übersicht der API angezeigt wird, enthält Links zu verschiedenen Informationen über die API. Beispiele: Implementierungsquellcode, Designdokumentation und Infrastruktursysteme. Weitere Informationen finden Sie unter Weitere Informationen.
Abhängigkeiten
Im Bereich Abhängigkeiten, der unten auf der Seite Übersicht angezeigt wird, werden alle Abhängigkeiten der API aufgelistet, einschließlich anderer interner APIs (im API-Hub vorhanden), externe APIs von Drittanbietern (nicht im API-Hub vorhanden) und andere Produktionssysteme. Beispiel: Datenbanken und Speicherlösungen. Weitere Informationen finden Sie unter Abhängigkeiten.
