Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen. info
Am Dienstag, dem 8. September 2015, haben wir eine vierteljährliche Version des Apigee Edge Developer Services-Portals für die Private Cloud veröffentlicht.
Der frühere Produktname „Apigee Edge On-premises Developer Services Portal“ oder „OPDK“ lautet jetzt „Apigee Edge Developer Services Portal for Private Cloud“.
Wenn Sie Fragen haben, wenden Sie sich an den Apigee Edge-Support.
Eine Liste aller Apigee Edge-Versionshinweise finden Sie unter Apigee-Versionshinweise.
Apigee Edge-Anforderungen für das Portal
Wenn Sie diese Version des Portals mit einer Installation von Edge for Private Cloud verbinden, müssen Sie sie mit Version 4.15.07.00 oder höher verbinden, damit alle SmartDocs-Funktionen unterstützt werden. Weitere Informationen finden Sie in den Versionshinweisen zu 4.15.07.00 – Apigee Edge for Private Cloud.
Neue Funktionen
Allgemeine Verfügbarkeit von SmartDocs
SmartDocs ist nach dem Abschluss der Betaphase jetzt allgemein verfügbar. Updates und neue Funktionen:
- Unterstützung für Swagger 2.0, einschließlich Import per Datei oder URL, einschließlich Unterstützung für benutzerdefinierte Sicherheitsbenennungsobjekte.
- Verbesserungen des visuellen Designs in den Vorlagen, mit denen SmartDocs generiert werden.
- Verbesserungen der Benutzerfreundlichkeit und des Workflows im Entwicklerportal, die über das Menü „Inhalte“ > „SmartDocs“ in Drupal verfügbar sind.
- Die bisher als „Benutzerdefiniertes Token“ bekannte Authentifizierung wird jetzt als „API-Schlüssel“ bezeichnet.
- Auf Revisionsebene definierte Authentifizierungssicherheitsobjekte.
- Konfiguration der Clientauthentifizierung auf Vorlagenebene. Bei neuen Überarbeitungen werden keine vorkonfigurierten SmartDocs-Clientanmeldedaten mehr zurückgesetzt.
Weitere Informationen zu den Funktionen finden Sie in diesem Blogpost.
Die SmartDocs-Dokumentation finden Sie unter APIs mit SmartDocs dokumentieren.
SmartDocs-Upgrade
Wenn Sie SmartDocs bereits in der Betaphase verwendet haben, müssen Sie SmartDocs in Ihrem Entwicklerportal aktualisieren, um die neuen Funktionen und Möglichkeiten der allgemein verfügbaren Version nutzen zu können.
Alle SmartDocs-Seiten, die bereits in Ihrem Entwicklerportal veröffentlicht wurden, funktionieren weiterhin. Sie müssen jedoch den Aktualisierungsprozess durchlaufen, bevor Sie Änderungen an bestehenden oder neuen Seiten bearbeiten oder veröffentlichen.
SmartDocs können zwar in Ihrem Entwicklerportal gerendert und veröffentlicht werden, sie werden jedoch aus dem API-Modell generiert, das sich in den Edge API Management Services von Apigee befindet. Alle Änderungen, die Sie an einem API-Modell in Edge vornehmen, sind in allen Ihren Pantheon-Umgebungen gleich (ähnlich wie Entwickler in Pantheon-Umgebungen vorhanden sind).
Von der SmartDocs-Betaversion auf die General Availability-Version upgraden
- Aktualisieren und testen Sie das Release vom 27.05.15 in Ihren dev- oder test-Umgebungen auf Pantheon.
- Erstellen Sie ein neues Modell, um alle vorhandenen API-Modelle zu ersetzen, die Sie verwendet haben.
- Wenn Sie Swagger- oder WADL-Dokumente importiert haben, importieren Sie sie noch einmal in eine neue Revision.
- Wenn Sie Ihr API-Modell über das SmartDocs-Modul verwaltet haben, exportieren Sie es als SmartDocs-JSON und importieren Sie es über einen Dateianhang in Ihr neues Modell.
- Legen Sie die Sicherheitseigenschaften der Revision Ihres Modells fest. Wählen Sie auf der Seite Inhalte > SmartDocs > Modell die Option Sicherheitseinstellungen aus.
- Prüfen Sie auf der Seite mit den Modelleinstellungen (Inhalte > SmartDocs) alle vorkonfigurierten Authentifizierungen, indem Sie in der Spalte „Vorgänge“ auf Einstellungen klicken.
- Aktualisieren Sie alle benutzerdefinierten Vorlagen, damit sie die Version 6 der CSS- und JS-Assets verwenden, und nehmen Sie Änderungen vor, um neue Objektnamen wie „authSchemes“ und „apiSchema“ zu berücksichtigen. Informationen zum Aktualisieren von SmartDocs-Vorlagen finden Sie unter SmartDocs zum Dokumentieren von APIs verwenden.
- Rendern Sie die Modellrevision noch einmal und veröffentlichen Sie sie.
- Nachdem Sie die neue Dokumentation geprüft haben, aktualisieren Sie Ihr Produktionsportal auf die Version 15.05.27.
Wenn Sie ein Edge-Unternehmenskunde sind und Fragen oder Bedenken zum Upgrade-Prozess haben, senden Sie bitte eine E-Mail an marsh@apigee.com und cnovak@apigee.com. Andernfalls nutzen Sie bitte die Apigee-Community, um die beste Antwort zu erhalten.
Fehlerkorrekturen
Folgende Fehler wurden in diesem Release behoben.
| Problem-ID | Description |
|---|---|
| DEVSOL-487 | Das Tagesformat in Monetization sollte von Administratoren konfiguriert werden können Das Datumsformat kann jetzt in Monetization unter den Monetarisierungseinstellungen für europäische und US-amerikanische Datumsformate konfiguriert werden. |
| DEVSOL-584 | Pfadparameter bei der ersten Verwendung nicht gespeichert Der Pfadparameter wurde beim Ausführen von Aufrufen nicht immer gespeichert. |
| DEVSOL-603 | Die Seite „Konfliktplan“ ist schlecht formatiert Beim Kauf eines Plans, der sich mit einem bestehenden Plan überschneidet, wird die angezeigte Seite jetzt für den Nutzer formatiert. |
| DEVSOL-709 | SmartDocs: URL-Vorlagenparameter nach dem Senden einer Anfrage mit leerem Wert nicht bearbeitbar Behebt das Problem, dass die Vorlagenparameter nach dem Senden der Anfrage über SmartDocs nicht mehr bearbeitet werden können, nachdem der Vorlagenparameter in der Methodendokumentation gelöscht wurde. |
| DEVSOL-723 | Nutzerfreundliche Meldungen bei SmartDocs-Importfehlern anzeigen |
| DEVSOL-1013 | E-Mail-Adressen von Entwicklerportalnutzern bearbeitbar machen Das Feld für die E-Mail-Adresse auf der Seite „Profil bearbeiten“ ist nicht mehr deaktiviert und Entwickler können ihre E-Mail-Adressen ändern. |
| DEVSOL-1244 | Umgebungsanzeige-Modul für OPDK-Releases nicht aktivieren |
| DEVSOL-1273 | „DevConnect Mint“ wird zweimal in der Modulliste angezeigt Unter „Module“ wurde „DevConnect Mint“ zweimal angezeigt. Dieser Fehler wurde jetzt behoben. |
| DEVSOL-1313 | JSON-/YAML-Datei oder URL-Import für Swagger und WADL wird unterstützt WADL-Dateien können jetzt über eine URL importiert und Swagger-Dateien hochgeladen werden. |
| DEVSOL-1339 | Änderung der Menüpositionen für SmartDocs SmartDocs befindet sich jetzt im Inhaltsmenü und die SmartDocs-Einstellungen im Admin-Menü „Einstellungen“. |
| DEVSOL-1340 | Betaprogramm bei der allgemeinen Verfügbarkeit entfernen |
| DEVSOL-1390 |
Die PHP SDK Edge-Bibliothek wurde aktualisiert, um das Problem beim Aufrufen von __toString() zu beheben. Schwerwiegender Fehler: Aufruf der Member-Funktion format() für ein Nicht-Objekt in /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php in Zeile 221 Dieser Fehler betrifft nur Monetarisierungskunden mit benutzerdefiniertem Code, der die toString()-Methode aufruft. |
| DEVSOL-1398 | SmartDocs-Petstore-Modell bei der Installation ohne Aufforderung des Nutzers importiert SmartDocs importiert jetzt das Petstore-Swagger-Beispiel während der Websiteinstallation (http://petstore.swagger.io/v2/swagger.json) anstelle des Wettermodells, um ein umfassenderes Beispiel für die Verwendung von SmartDocs zu haben. |
| DEVSOL-1407 | Cron schlägt fehl, wenn viele Entwickler vorhanden sind Wenn Drupal-Cron ausgeführt wird, kann es bei einer großen Anzahl von Entwicklern zu einem Zeitüberschreitungsproblem kommen. Wenn eine Organisation mehr als 200 Nutzer hat, wird jetzt ein Batchprozess verwendet. |
| DEVSOL-1410 | Verbindungsfehler bei der Installation des Entwicklerportals nicht sichtbar Dem Installationsprogramm wurden bessere Fehlermeldungen hinzugefügt, wenn die Edge-Verwaltungsverbindung nicht funktioniert, um Probleme bei der Fehlerbehebung zu minimieren. |
| DEVSOL-1422 | SMTP-Konfigurationsformular aus dem Apigee-Profil entfernen Während der Installation werden Sie nicht mehr gefragt, ob Sie SMTP konfigurieren möchten. Stattdessen können Sie dies nach Abschluss der Installation tun. Dazu müssen Sie das SMTP-Modul aktivieren und richtig konfigurieren. |
| DEVSOL-1427 |
Hooks zum Modul „Devconnect Developer Apps“ hinzufügen, um die Analyse von Daten zu ermöglichen # hook_devconnect_developer_apps_analytics_chart_data_alter() # hook_devconnect_developer_app_analytics_datapoints_params_alter() # hook_devconnect_developer_app_analytics_datapoints_alter() Mit diesen Optionen können benutzerdefinierte Module das Analysediagramm der Entwickler-App ändern. |
| DEVSOL-1464 | Schwerwiegender Fehler beim Speichern der Autorisierungseinstellungen für ein Modell Wenn ein Sicherheitsschema gelöscht wird, wird jetzt ein Kästchen angezeigt, in dem Sie auswählen können, ob das zugehörige Autorisierungsschema der Vorlage ebenfalls gelöscht werden soll. |
| DEVSOL-1470 | Menülink „APIs“ und entsprechende Ansicht erstellen Dev Portal SmartDocs enthält jetzt standardmäßig einen Link zur gerenderten SmartDocs-Dokumentation im Hauptmenü mit dem Namen „APIs“. Dieser Link führt zu allen Modellen mit veröffentlichten Methoden. |
| DEVSOL-1486 | SmartDocs-Aufrufe können mit einem vordefinierten Schlüssel authentifiziert werden Ermöglicht die Authentifizierung mit sowohl vorab bereitgestellten als auch vom Nutzer bereitgestellten API-Schlüsseln. |
| DEVSOL-1499 | HTML-Code wird in SmartDocs-Parameterbeschreibungen nicht geparst HTML-Code wird jetzt in SmartDocs-Parameterbeschreibungen geparst. |
| DEVSOL-1507 | Mehrere Parameter können einer API mit der Methode „Add“ nicht hinzugefügt werden Sie können jetzt einer SmartDocs-API beim Bearbeiten der Methode mehrere Parameter hinzufügen. |
| DEVSOL-1509 | Ich kann das Feld „sample“ für eine SmartDocs-API nicht bearbeiten. Sie können jetzt „Body MIME type“, „Body documentation“ und „Body sample“ festlegen, wenn Sie eine SmartDocs-Seite bearbeiten. |
| DEVSOL-1534 | Content-type wird nicht in der SmartDocs-Ausgabe ausgefüllt Content-type wird jetzt auf der SmartDocs-Methodenseite ausgefüllt. |
| DEVSOL-1554 | Ungültiger Datumsvergleich bei der Monetarisierung Auf dem Tab „Erworbenes Abo“ für Entwicklerportale mit aktivierter Monetarisierung wurde die Schaltfläche „Kündigen“ nie für ein Abo mit einem zukünftigen Startdatum angezeigt. |
| DEVSOL-1556 | Alte Version von Drupal-Modulen wird ausgeliefert Die Module „media_youtube“ und „features“ wurden auf die neueste Version aktualisiert. |
| DEVSOL-1558 | SmartDocs-Methodenseiten werden für das PetStore-Beispiel nicht gerendert Bei Neuinstallationen werden die Beispielmethoden von SmartDocs für PetStore jetzt korrekt gerendert. |
| DEVSOL-1562 | Ansicht für jedes SmartDocs-Modell generieren Wenn Sie ein neues Modell erstellen, wird standardmäßig eine neue Ansicht für dieses Modell erstellt. |
| DEVSOL-1565 | Beim Bearbeiten einer SmartDocs-Methode wird ein schwerwiegender Fehler generiert Ein Problem wurde behoben, bei dem beim Bearbeiten einer SmartDocs-Methode manchmal ein Fehler generiert wurde. |
| DEVSOL-1567 | „Modell hinzufügen“ im oberen Admin-Menü Das Problem, dass der Menüpunkt „Modell hinzufügen“ im oberen Admin-Menü angezeigt wurde, wurde behoben. |
| DEVSOL-1576 | In der API-Dokumentationsansicht wird der Modellname anstelle des Anzeigenamens angezeigt Auf der Seite „API-Dokumentation“, die angezeigt wird, wenn Sie im Menü auf „APIs“ klicken, wurde der interne Name des Modells anstelle des Anzeigenamens angezeigt. Wenn Sie ein Update auf die Release-Version durchführen und diese Ansicht geändert haben, müssen Sie die Ansicht zurücksetzen, um die Änderungen zu sehen. Gehen Sie dazu so vor: # Melden Sie sich als Administrator an. # Rufen Sie „Structure“ > „Views“ auf. # Klicken Sie auf das Drop-down-Menü neben „Edit“ für „SmartDocs Models“, um alle Vorgänge aufzurufen. # Wenn Sie „revert“ sehen, haben Sie den Code mit Ihrer eigenen Änderung überschrieben. Klicken Sie auf „Zurücksetzen“, um die Ansicht auf den Standardzustand zurückzusetzen. Dadurch werden alle Änderungen entfernt, die Sie an dieser Ansicht vorgenommen haben. |
| DEVSOL-1578 | Sowohl das Wetter- als auch das Petstore-Modell bei der Installation von Websites rendern Sowohl das Petstore- als auch das Wetter-SmartDocs-Modell werden auf neuen Websites importiert. |
| DEVSOL-1584 | Tarife können nicht gekauft werden Ein Problem wurde behoben, bei dem das Kaufformular für Monetarisierungstarife für die Cloud-Version 15.05.27.00 und 15.06.08.00 nicht gesendet wurde, wenn Sie das Apigee Responsive-Theme oder ein untergeordnetes Theme des Apigee Responsive-Themes verwendet haben. |
| DEVSOL-1597 | Entwickler-Timeout-Einstellungen können nicht geändert werden Ein Fehler, bei dem die Edge-Verbindungs-Timeout-Einstellungen nicht richtig angewendet wurden, wurde behoben. |
| DEVSOL-1620 |
Aktualisierungen für das „Ich“-Modul, die Umgebungsanzeige und das Modul für Funktionen https://www.drupal.org/project/me https://www.drupal.org/project/environment_indicator |
| DEVSOL-1648 | Achten Sie darauf, dass arg_separator.output auf „&“ gesetzt ist, um reCAPTCHA-Fehler zu vermeiden. Ein plattformbezogenes Problem, bei dem die Verwendung von Google reCAPTCHA nicht möglich war, wurde behoben. |
| DEVSOL-1651 | Fehler beim Apigee-Basisthema, wenn das SmartDocs-Modul nicht aktiviert ist Das Apigee-Basisthema ist nicht mehr davon abhängig, dass das SmartDocs-Modul aktiviert ist. |
| DEVSOL-1654 |
Version von „admin_views“ aktualisieren, um kritischen Sicherheitsfix zu übernehmen
|