Übersicht über das Entwicklerportal

Das Entwicklerportal ist eine automatisch generierte, vollständig anpassbare Website mit der Dokumentation Ihrer APIs. Dort können API-Consumer ihre APIs ermitteln, erfahren, wie sie verwendet werden, Zugriff anfordern und die APIs ausprobieren.

Wie in diesem Artikel beschrieben, können Sie das Entwicklerportal für Ihre spezifischen Szenarien anpassen und erweitern.

API Management developer portal

Verfügbarkeit

Wichtig

Diese Funktion ist auf den Ebenen Premium, Standard, Basic und Entwickler von API Management verfügbar.

Migration vom Legacyportal

Wichtig

Das Legacyentwicklerportal ist mittlerweile veraltet, und es werden nur noch Sicherheitsupdates angewendet. Sie können die Anwendung bis Oktober 2023 wie gewohnt weiterhin verwenden, daraufhin wird sie aus allen API Management-Diensten entfernt.

Die Migration zum neuen Entwicklerportal ist in einem eigenen Artikel in der Dokumentation beschrieben.

Anpassen und Formatieren des verwalteten Portals

Der API Management-Dienst umfasst ein integriertes verwaltetes Entwicklerportal, das laufend aktualisiert wird. Sie können über die Benutzeroberfläche des Azure-Portals darauf zugreifen.

Sie können das verwaltete Portal über den integrierten visuellen Drag & Drop-Editor anpassen und formatieren:

  • Verwenden Sie den visuellen Editor, um Seiten, Medien, Layouts, Menüs, Stile oder Websiteeinstellungen zu ändern.

  • Nutzen Sie integrierte Widgets, um Text, Bilder, Schaltflächen und andere Objekte hinzuzufügen, die das Portal direkt unterstützt.

  • Fügen Sie benutzerdefinierten HTML-Code hinzu, z. B. HTML-Code für ein Formular oder zum Einbetten eines Videoplayers. Der benutzerdefinierte Code wird in einem Inlineframe (iframe) gerendert.

Beispiele für Anpassungen finden Sie in diesem Tutorial.

Hinweis

Das verwaltete Entwicklerportal empfängt Updates und wendet diese automatisch an. Änderungen, die Sie gespeichert, aber nicht im Entwicklerportal veröffentlicht haben, bleiben während eines Updates in diesem Zustand.

Erweiterbarkeit

In einigen Fällen benötigen Sie möglicherweise Funktionen, die über die im verwalteten Entwicklerportal unterstützten Anpassungs- und Formatierungsoptionen hinausgehen. Wenn Sie benutzerdefinierte Logik implementieren müssen, die nicht direkt unterstützt wird, können Sie die Codebasis des Portals ändern, die auf GitHub verfügbar ist. Beispielsweise können Sie ein neues Widget erstellen, das in ein Supportsystem eines Drittanbieters integriert werden soll. Wenn Sie neue Funktionen implementieren, können Sie aus folgenden Optionen wählen:

  • Selbsthosting des resultierenden Portals außerhalb Ihres API Management-Diensts. Wenn Sie das Portal selbst hosten, sind Sie der Maintainer und selbst für dessen Upgrades verantwortlich. Die Unterstützung durch den Azure-Support ist auf die grundlegende Einrichtung selbstgehosteter Portale beschränkt.
  • Öffnen Sie einen Pull Request, damit das API Management-Team neue Funktionen mit der Codebasis des verwalteten Portals zusammenführen kann.

Details und Anweisungen zur Erweiterbarkeit finden Sie im GitHub-Repository und im Tutorial zum Implementieren eines Widgets. Das Tutorial zum Anpassen des verwalteten Portals führt Sie Schritt für Schritt durch den Verwaltungsbereich des Portals, der sowohl in der verwalteten als auch in der selbstgehosteten Version zur Verfügung steht.

Nächste Schritte

Weitere Informationen zum Entwicklerportal:

Weitere Ressourcen: