Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info
Als API-Anbieter benötigen Sie eine Möglichkeit, Ihre APIs bereitzustellen, Entwickler über Ihre APIs zu informieren, Entwickler zu registrieren und Entwicklern die Registrierung von Apps zu ermöglichen. Apigee Edge bietet ein Developer Services-Portal, mit dem Sie Ihre eigene benutzerdefinierte Website erstellen und veröffentlichen können, um diese Dienste Ihrer Entwicklungsgemeinschaft 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 WADL-Spezifikation, die Ihre API beschreibt, kann in SmartDocs importiert und zum Veröffentlichen einer API-Referenzdokumentation in Ihrem Portal verwendet werden. Die API-Referenzdokumentation 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 (Cross-Origin Resource Sharing) erforderlich, damit sie erfolgreich sind. Die CORS-Unterstützung wird vom Proxy „smartdocs“ auf Edge (in der Organisation „VALIDATE“) bereitgestellt, der als Proxy für alle SmartDocs-Anfragen an den gewünschten Endpunkt dient. Der Proxy „smartdocs“ wird beim Installieren von SmartDocs erstellt.
Beispiel:
Die URL des SmartDocs-Proxy wird unter „Konfiguration“ -> „SmartDocs“ -> „SmartDocs-Proxy-URL“ als konfigurierbare Eigenschaft angezeigt. Möglicherweise müssen Sie diese URL ändern, wenn sich Ihre API in einem privaten Netzwerk befindet und Live-API-Anfragen mit SmartDocs aus Ihrem Portal fehlschlagen.
So kommuniziert das Entwicklerportal mit Edge
Die meisten Informationen, die im Entwicklerportal angezeigt werden, werden in Edge gespeichert und abgerufen, einschließlich Smartdocs, Entwicklern, Produkten und Entwickler-Apps. Informationen zur Edge-Organisation und die Anmeldedaten für den Dev-Administrator können über den Menübefehl „Konfiguration“ -> „Devportal“ konfiguriert werden.
Weitere Informationen finden Sie unter Kommunikation zwischen dem Portal und Edge.