Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur
Dokumentation vonApigee X. info
Als API-Anbieter benötigen Sie eine Möglichkeit, Ihre APIs verfügbar zu machen, Entwickler über Ihre APIs zu informieren, Entwickler zu registrieren und ihnen die Registrierung von Apps zu ermöglichen. Apigee Edge bietet Ihnen ein Developer Services-Portal, mit dem Sie Ihre eigene angepasste Website erstellen und starten können, um diese Dienste Ihrer Entwickler-Community zur Verfügung zu stellen. Weitere Informationen zu Entwicklerportalen finden Sie unter Was ist ein Entwicklerportal?
In den folgenden Abschnitten werden wichtige Konzepte beschrieben, die Sie kennen sollten, bevor Sie Probleme mit Ihrem Entwicklerportal beheben.
Funktionsweise von SmartDocs
Eine OpenAPI-Spezifikation (JSON oder YAML) oder eine WADL-Spezifikation, die Ihre API beschreibt, kann in SmartDocs importiert und verwendet werden, um die API-Referenzdokumentation in Ihrem Portal zu veröffentlichen. Die API-Referenz Dokumentation wird automatisch auf dem Tab „APIs“ in Ihrem Portal angezeigt. Entwickler finden die API-Dokumentation über das Portal und können Live-API-Anfragen stellen. Da die API-Anfragen von einem Browser stammen, ist CORS-Unterstützung (Cross-Origin Resource Sharing) erforderlich, damit sie erfolgreich sind. Die CORS-Unterstützung wird vom "smartdocs"-Proxy in Edge (in der Organisation "VALIDATE") bereitgestellt, der als Proxy für alle SmartDocs-Anfragen an den beabsichtigten Endpunkt fungiert. Der "smartdocs"-Proxy wird erstellt, wenn Sie SmartDocs installieren.
Beispiel:
Die URL des SmartDocs-Proxys wird als konfigurierbare Eigenschaft unter „Konfiguration“ -> „SmartDocs“ -> „SmartDocs-Proxy-URL“ angezeigt. Möglicherweise müssen Sie diese URL ändern, wenn sich Ihre API in einem privaten Netzwerk befindet und Live-API-Anfragen über SmartDocs von Ihrem Portal fehlschlagen.
Kommunikation zwischen dem Entwicklerportal und Edge
Das Entwicklerportal speichert und ruft die meisten Informationen, die es anzeigt, aus Edge ab, einschließlich SmartDocs, Entwickler, Produkte und Entwickler-Apps. Informationen zur Edge-Organisation und Anmeldedaten für den Entwickleradministrator können über den Menübefehl „Konfiguration“ -> „Entwicklerportal“ konfiguriert werden.
Weitere Informationen finden Sie unter Kommunikation zwischen dem Portal und Edge.