Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
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 Entwicklern die Registrierung von Apps zu ermöglichen. Apigee Edge bietet Ihnen ein Portal für Entwicklerdienste, mit dem Sie Ihre eigene benutzerdefinierte Website erstellen und starten können, um diese Dienste für Ihre Entwicklungs-Community bereitzustellen. 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 im Entwicklerportal beheben.
Funktionsweise von SmartDocs
Eine OpenAPI- (JSON oder YAML)- oder WADL-Spezifikation, die Ihre API beschreibt, kann in SmartDocs importiert und zur Veröffentlichung der API-Referenzdokumentation im Portal verwendet werden. Die API-Referenzdokumentation wird automatisch auf dem Tab „APIs“ in Ihrem Portal angezeigt. Entwickler finden die API-Dokumentation im 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. CORS-Unterstützung wird vom Proxy „Smartdocs“ in Edge (in der Organisation „VALIDATE“) bereitgestellt, der als Proxy für alle SmartDocs-Anfragen an den gewünschten Endpunkt fungiert. Der Proxy "Smartdocs" wird erstellt, wenn Sie SmartDocs installieren.
Beispiel:
Die URL des Smartdocs-Proxys wird als konfigurierbare Eigenschaft unter Konfiguration -> SmartDocs -> SmartDocs-Proxy-URL angezeigt. Sie müssen diese URL möglicherweise ä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
Das Entwicklerportal speichert und ruft die meisten Informationen aus Edge ab, einschließlich Smartdocs, Entwickler, Produkte und Entwickler-Apps. Edge-Organisationsinformationen und devadmin-Anmeldedaten können mit dem Menübefehl „Konfiguration“ -> „Devportal“ konfiguriert werden.
Weitere Informationen finden Sie unter Kommunikation zwischen dem Portal und Edge.