Vous consultez la documentation Apigee Edge.
Accédez à la
documentation**Apigee X**. info
Le mardi 8 septembre 2015, nous avons lancé une version trimestrielle du portail des services pour les développeurs Apigee Edge pour le cloud privé.
L'ancien nom de produit "Apigee Edge On-premises Developer Services Portal" ou "OPDK" est désormais "Apigee Edge Developer Services Portal for Private Cloud".
Si vous avez des questions, contactez l'assistance Apigee Edge.
Pour obtenir la liste de toutes les notes de version d'Apigee Edge, consultez Notes de version d'Apigee.
Exigences d'Apigee Edge pour le portail
Si vous connectez cette version du portail à une installation d'Edge pour le cloud privé, vous devez la connecter à la version 4.15.07.00 ou ultérieure pour vous assurer que toutes les fonctionnalités SmartDocs sont compatibles. Pour en savoir plus, consultez 4.15.07.00 – Notes de version d'Apigee Edge pour le cloud privé.
Nouvelles fonctionnalités
Disponibilité générale de SmartDocs
SmartDocs passe de la version bêta à la disponibilité générale. Voici quelques-unes des mises à jour et nouvelles fonctionnalités :
- Compatibilité avec Swagger 2.0, y compris l'importation par fichier ou URL, et compatibilité avec les objets de sécurité nommés de manière personnalisée.
- Améliorations de la conception visuelle dans les modèles qui génèrent des SmartDocs.
- Améliorations de l'ergonomie et du workflow dans le portail des développeurs, disponibles via le menu "Content" > "SmartDocs" dans Drupal.
- L'authentification "Custom Token" (Jeton personnalisé) est désormais appelée "API Key" (Clé API).
- Objets de "sécurité" d'authentification définis au niveau de la révision.
- Configuration de l'authentification du client au niveau du modèle. Les nouvelles révisions ne réinitialisent plus les identifiants client SmartDocs préconfigurés.
Pour en savoir plus sur les fonctionnalités, consultez cet article de blog.
Pour obtenir de la documentation sur SmartDocs, consultez Utiliser SmartDocs pour documenter les API.
Processus de mise à niveau de SmartDocs
Si vous avez déjà utilisé SmartDocs pendant la période bêta, les nouvelles fonctionnalités et capacités de la version en disponibilité générale nécessitent que vous mettiez à niveau SmartDocs dans votre portail des développeurs.
Toutes les pages SmartDocs déjà publiées dans votre portail des développeurs continueront de fonctionner, mais vous devez suivre le processus de mise à jour avant de modifier ou de publier des modifications sur des pages existantes ou nouvelles.
N'oubliez pas que, bien que vous puissiez afficher et publier des SmartDocs dans votre portail des développeurs, ils sont générés à partir du modèle d'API qui réside dans les services de gestion des API Edge d'Apigee. Toutes les modifications que vous apportez à un modèle d'API dans Edge seront les mêmes dans tous vos environnements Pantheon (comme les développeurs existent dans les environnements Pantheon).
Pour passer de la version bêta de SmartDocs à la disponibilité générale
- Mettez à jour et testez la version 15.05.27 dans vos dev ou test environnements sur Pantheon.
- Créez un modèle pour remplacer tout modèle d'API existant que vous avez utilisé.
- Si vous avez importé des documents Swagger ou WADL, importez-les à nouveau dans une nouvelle révision.
- Si vous avez géré votre modèle d'API via le module SmartDocs, exportez-le au format SmartDocs JSON et importez-le dans votre nouveau modèle à l'aide d'une pièce jointe.
- Définissez les propriétés de sécurité de la révision de votre modèle. Sur la page Content >
SmartDocs > model (Contenu > SmartDocs > modèle), sélectionnez Security Settings (Paramètres de sécurité).
- Vérifiez toute authentification préconfigurée sur la page des paramètres du modèle (Content >
SmartDocs) en cliquant sur Settings dans la colonne "Operations" (Opérations).
- Mettez à jour tous les modèles personnalisés pour utiliser la version 6 des éléments CSS et JS, et apportez des modifications pour refléter tous les nouveaux noms d’objets, tels que authSchemes et apiSchema. Pour en savoir plus sur la mise à jour des modèles SmartDocs, consultez Utiliser SmartDocs pour documenter les API.
- Affichez et publiez à nouveau la révision de votre modèle.
- Après avoir validé la nouvelle documentation, mettez à jour votre production portail vers la version 15.05.27.
Si vous êtes un client d'entreprise Edge et que vous avez des questions ou des préoccupations concernant le processus de mise à niveau, veuillez envoyer un e-mail à marsh@apigee.com et cnovak@apigee.com. Sinon, veuillez utiliser la communauté Apigee pour obtenir la meilleure réponse.
Bugs résolus
Les bugs suivants sont résolus dans cette version.
| ID du problème | Description |
|---|---|
| DEVSOL-487 | Le format de jour dans la monétisation doit être configurable par les administrateurs Le format de date est désormais configurable dans la monétisation sous les paramètres de monétisation pour les formats de date européens et américains. |
| DEVSOL-584 | Le paramètre de chemin d'accès n'est pas mémorisé lors de la première utilisation Le paramètre de chemin d'accès lors des appels n'était pas toujours mémorisé. |
| DEVSOL-603 | La page "Conflict Plan" (Plan de conflit) est mal formatée Lors de l'achat d'un forfait qui chevauche un forfait existant, la page affichée est désormais correctement formatée pour l'utilisateur. |
| DEVSOL-709 | SmartDocs : le paramètre de modèle d'URL n'est pas modifiable après l'envoi d'une requête avec une valeur vide Résout le problème qui rend les paramètres de modèle non modifiables après l'envoi de la requête à partir de SmartDocs après la suppression du paramètre de modèle dans la documentation de la méthode. |
| DEVSOL-723 | Afficher des messages conviviaux en cas d'échec de l'importation SmartDocs |
| DEVSOL-1013 | Rendre les adresses e-mail des utilisateurs du portail des développeurs modifiables Le champ d'adresse e-mail de la page de modification du profil ne sera plus désactivé et les développeurs pourront modifier leur adresse e-mail. |
| DEVSOL-1244 | Ne pas activer le module "Environment Indicator" (Indicateur d'environnement) pour les versions OPDK |
| DEVSOL-1273 | "DevConnect Mint" apparaît deux fois dans la liste des modules Sous "Modules", "Dev Connect Mint" s'affichait deux fois. Ce problème est maintenant résolu. |
| DEVSOL-1313 | Importer des fichiers JSON/YAML ou des URL pour Swagger et WADL Les fichiers WADL peuvent désormais être importés via une URL et les fichiers Swagger peuvent être importés. |
| DEVSOL-1339 | Modifier l'emplacement du menu d'administration SmartDocs SmartDocs se trouve désormais dans le menu "Content" (Contenu), et les paramètres SmartDocs se trouvent dans le menu d'administration des paramètres. |
| DEVSOL-1340 | Supprimer la version bêta lors du passage à la disponibilité générale |
| DEVSOL-1390 |
La bibliothèque PHP SDK Edge a été mise à jour pour résoudre le problème d'appel de
__toString() Fatal error: Call to a member function format() on a non-object in /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php on line 221 Il s'agit d'un bug qui n'affecte que les clients de la monétisation avec du code personnalisé appelant la méthode toString(). |
| DEVSOL-1398 | Le modèle SmartDocs Petstore est importé lors de l'installation sans inviter l'utilisateur SmartDocs importe désormais l'exemple Swagger de la boutique d'animaux de compagnie lors de l'installation du site (http://petstore.swagger.io/v2/swagger.json) au lieu du modèle météo afin d'avoir un exemple plus complet d'utilisation de SmartDocs. |
| DEVSOL-1407 | Échec de Cron lorsqu'il y a de nombreux développeurs Lors de l'exécution de Cron Drupal, un grand nombre de développeurs provoquait un problème de délai avant expiration. Lorsqu'une organisation compte plus de 200 utilisateurs, un processus par lot est désormais utilisé. |
| DEVSOL-1410 | Les erreurs de connexion ne sont pas apparentes lors de l'installation du portail des développeurs Ajout de meilleurs messages d'erreur à l'installateur lorsque la connexion de gestion Edge ne fonctionne pas afin de minimiser les problèmes de dépannage. |
| DEVSOL-1422 | Supprimer le formulaire de configuration SMTP du profil Apigee Le processus d'installation ne vous demande plus si vous souhaitez configurer SMTP. Vous pouvez le faire une fois l'installation terminée en suivant la pratique Drupal standard qui consiste à activer le module SMTP et à le configurer correctement. |
| DEVSOL-1427 |
Ajouter des hooks au module "Devconnect Developer Apps" (Applications pour développeurs Devconnect) pour permettre la modification des
données d'analyse # hook_devconnect_developer_apps_analytics_chart_data_alter() # hook_devconnect_developer_app_analytics_datapoints_params_alter() # hook_devconnect_developer_app_analytics_datapoints_alter() Ils permettent aux modules personnalisés de modifier le graphique d'analyse d'applications pour développeurs. |
| DEVSOL-1464 | Erreur fatale lors de l'enregistrement des paramètres d'authentification pour un modèle Lorsqu'un schéma de sécurité est supprimé, une case à cocher permet désormais de sélectionner si le schéma d'authentification du modèle associé doit également être supprimé. |
| DEVSOL-1470 | Créer un lien de menu "APIs" et la vue correspondante SmartDocs du portail des développeurs est désormais fourni par défaut avec un lien vers la documentation SmartDocs affichée dans le menu principal nommé "APIs" (API), qui renvoie à tous les modèles avec des méthodes publiées. |
| DEVSOL-1486 | Les appels SmartDocs peuvent s'authentifier avec une clé prédéfinie Permet l'authentification avec des clés API préfournies et fournies par l'utilisateur. |
| DEVSOL-1499 | Le code HTML n'est pas analysé dans les descriptions des paramètres SmartDocs Le code HTML est désormais analysé dans les descriptions des paramètres SmartDocs. |
| DEVSOL-1507 | Impossible d'ajouter plusieurs paramètres à une API avec "Add Method" (Ajouter une méthode) Vous pouvez désormais ajouter plusieurs paramètres à une API SmartDocs lorsque vous modifiez la méthode. |
| DEVSOL-1509 | Impossible de modifier le champ "sample" (exemple) pour une API SmartDocs Vous pouvez désormais définir le "Body MIME type" (Type MIME du corps), la "Body documentation" (Documentation du corps) et l'exemple de corps lorsque vous modifiez une page SmartDocs. |
| DEVSOL-1534 | Le type de contenu n'est pas renseigné dans la sortie SmartDocs Le type de contenu est désormais renseigné dans la page de la méthode SmartDocs. |
| DEVSOL-1554 | Comparaison de dates non valide dans la monétisation Dans l'onglet "Purchased plan" (Forfait acheté) des portails des développeurs pour lesquels la monétisation est activée, le bouton "Cancel" (Annuler) ne s'affichait jamais pour un forfait avec une date de début future, |
| DEVSOL-1556 | Ancienne version des modules Drupal en cours de livraison Les modules media_youtube et features ont été mis à jour vers la dernière version. |
| DEVSOL-1558 | Les pages de méthode SmartDocs ne s'affichent pas pour l'exemple PetStore Sur les nouvelles installations, les méthodes SmartDocs PetStore de l'exemple s'affichent désormais correctement. |
| DEVSOL-1562 | Générer une vue pour chaque modèle SmartDocs Lors de la création d'un modèle, une vue est créée par défaut pour ce modèle. |
| DEVSOL-1565 | La modification de la méthode SmartDocs génère une erreur fatale Résolution du problème qui faisait qu'une erreur se produisait parfois lors de la modification d'une méthode SmartDocs. |
| DEVSOL-1567 | "Add model" (Ajouter un modèle) s'affiche dans le menu d'administration supérieur Résolution du problème qui faisait que l'élément de menu "Add model" (Ajouter un modèle) s'affichait dans le menu d'administration supérieur. |
| DEVSOL-1576 | La vue de la documentation de l'API affiche le nom du modèle, et non le nom à afficher La page de documentation de l'API qui s'affichait lorsque vous cliquiez sur "APIs" (API) dans le menu affichait le nom interne du modèle au lieu du nom à afficher. Si vous effectuez une mise à jour vers la version et que vous avez modifié cette vue, vous devrez rétablir votre vue pour voir ces modifications en procédant comme suit : # Connectez-vous en tant qu'administrateur # Accédez à "Structure" > "Views" (Vues) # Cliquez sur le menu déroulant à côté de "Edit" (Modifier) sur "SmartDocs Models" (Modèles SmartDocs) pour afficher toutes les opérations. # Si vous voyez "revert" (rétablir), cela signifie que vous avez écrasé le code avec votre propre modification. Cliquez sur "revert" (rétablir) pour rétablir l'état par défaut de la vue. Notez que cela supprimera toutes les modifications que vous avez apportées à cette vue. |
| DEVSOL-1578 | Afficher les modèles météo et Petstore sur les installations de site Les modèles SmartDocs Petstore et météo sont importés sur les nouveaux sites. |
| DEVSOL-1584 | Impossible d'acheter des forfaits Résolution du problème qui faisait que le formulaire d'achat de forfaits de monétisation n'était pas envoyé pour les versions cloud 15.05.27.00 et 15.06.08.00 si vous utilisiez le thème Apigee Responsive ou un sous-thème du thème Apigee Responsive. |
| DEVSOL-1597 | Impossible de modifier les paramètres de délai avant expiration du développeur Correction d'un bug qui faisait que les paramètres de délai avant expiration de la connexion Edge n'étaient pas correctement appliqués. |
| DEVSOL-1620 |
Mises à niveau des modules "Me" (Moi), "Environment Indicator" (Indicateur d'environnement) et "Features" (Fonctionnalités) https://www.drupal.org/project/me https://www.drupal.org/project/environment_indicator |
| DEVSOL-1648 | S'assurer que arg_separator.output est '&' pour éviter la rupture de reCAPTCHA Résolution d'un problème lié à la plate-forme qui faisait que l'utilisation de Google reCAPTCHA était interrompue. |
| DEVSOL-1651 | Le thème de base Apigee échoue si le module SmartDocs n'est pas activé Le thème apigee_base ne dépend plus de l'activation du module SmartDocs. |
| DEVSOL-1654 |
Augmenter la version d'admin_views pour appliquer un correctif de sécurité critique
|