15.05.27.00 : Notes de version du portail des services pour les développeurs Apigee

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X.
info

Le mardi 2 juin 2015, nous avons lancé une nouvelle version cloud du portail de services pour les développeurs Apigee.

Pour toute question, contactez l'assistance client Apigee.

Pour obtenir la liste de toutes les notes de version d'Apigee Edge, consultez les notes de version d'Apigee.

Nouvelles fonctionnalités

Disponibilité générale de SmartDocs

SmartDocs passe de la version bêta à la disponibilité générale. Voici les mises à jour et les nouvelles fonctionnalités:

  • Compatibilité avec Swagger 2.0, y compris l'importation par fichier ou URL, y compris la 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'usabilité et du workflow dans le portail des développeurs, disponibles dans le menu "Contenu > SmartDocs" de Drupal.
  • L'authentification "Jeton personnalisé" s'appelle désormais "Clé API".
  • Objets "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 en savoir plus sur SmartDocs, consultez Utiliser SmartDocs pour documenter les API.

Processus de mise à niveau de SmartDocs

Si vous utilisiez déjà SmartDocs pendant la période bêta, vous devez mettre à niveau SmartDocs dans votre portail pour les développeurs pour profiter des nouvelles fonctionnalités de la version disponible pour tous.

Les pages SmartDocs déjà publiées dans votre portail pour les développeurs continueront de fonctionner, mais vous devez suivre la procédure de mise à jour avant de modifier ou de publier des modifications apportées à des pages existantes ou nouvelles.

N'oubliez pas que, même si vous pouvez afficher et publier des SmartDocs dans votre portail des développeurs, ils sont générés à partir du modèle d'API qui se trouve 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 dans les environnements Pantheon).

Passer de la version bêta de SmartDocs à la version disponible pour tous les utilisateurs

  1. Mettez à jour et testez la version 15.05.27 dans vos environnements dev ou test sur Pantheon.
  2. Créez un modèle pour remplacer tout modèle d'API existant que vous utilisiez.
    • 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 JSON SmartDocs, puis importez-le dans votre nouveau modèle à l'aide d'une pièce jointe.
  3. Définissez les propriétés de sécurité de la révision de votre modèle. Sur la page Contenu > SmartDocs > modèle, sélectionnez Paramètres de sécurité.
  4. Vérifiez toute authentification préconfigurée sur la page des paramètres du modèle (Contenu > SmartDocs) en cliquant sur Paramètres dans la colonne "Opérations".
  5. Mettez à jour les modèles personnalisés pour qu'ils utilisent la version 6 des composants CSS et JS, et apportez les modifications nécessaires pour refléter les nouveaux noms d'objets, tels que authSchemes et apiSchema. Pour savoir comment mettre à jour des modèles SmartDocs, consultez Utiliser SmartDocs pour documenter des API.
  6. Réaffichez et publiez la version de votre modèle.
  7. Après avoir validé la nouvelle documentation, mettez à jour votre portail de production vers la version 15.05.27.

Si vous êtes un client Edge Enterprise 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 "Monétisation" doit être configurable par les administrateurs
Le format de date est désormais configurable dans "Monétisation", sous les paramètres de monétisation, pour les formats de date européens et américains.
DEVSOL-603 Mauvais formatage de la page du forfait en conflit
Lorsque vous achetez un forfait qui se chevauche avec un forfait existant, la page affichée est désormais bien formatée pour l'utilisateur.
DEVSOL-642 Déplacer les configurations au niveau du client des paramètres de sécurité vers les paramètres du modèle
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
corrige le problème qui rend les paramètres de modèle non modifiables après l'envoi de la requête depuis SmartDocs après avoir supprimé le paramètre de modèle dans la documentation de la méthode.
DEVSOL-1013 Modification des adresses e-mail des utilisateurs du portail des développeurs pour les rendre 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-1273 "DevConnect Mint" apparaît deux fois dans la liste des modules
Sous "Modules", "DevConnect Mint" s'affichait deux fois. Ce problème est désormais résolu.
DEVSOL-1313 Compatibilité avec l'importation de fichiers JSON/YAML ou d'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 Modification des emplacements du menu d'administration SmartDocs
SmartDocs se trouve désormais dans le menu "Contenu", et les paramètres SmartDocs dans le menu d'administration des paramètres.
DEVSOL-1340 Suppression de la version bêta lors de la transition vers GA
SmartDocs se trouve désormais dans le menu "Contenu", et les paramètres SmartDocs dans le menu "Administration des paramètres".
DEVSOL-1390 La bibliothèque PHP SDK Edge a été mise à jour pour résoudre le problème d'appel de __toString()
La bibliothèque PHP SDK Edge a été mise à jour pour résoudre le problème d'appel de __toString() sur l'objet DeveloperRatePlan, ce qui génère cette erreur: {quote} Erreur fatale: Appel d'une fonction membre format() sur un objet non défini dans /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php à la ligne 221 {quote} Il s'agit d'un bug qui ne concerne que les clients de monétisation avec du code personnalisé appelant la méthode toString().
DEVSOL-1398 Modèle SmartDocs Petstore importé lors de l'installation sans invite à l'utilisateur
SmartDocs importe désormais l'exemple swagger Petstore lors de l'installation du site (http://petstore.swagger.io/v2/swagger.json) au lieu du modèle météo afin d'obtenir un exemple plus complet de l'utilisation de SmartDocs.
DEVSOL-1407 Le cron échoue lorsque de nombreux développeurs sont présents
Lors de l'exécution du cron Drupal, un grand nombre de développeurs a provoqué 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-1470 Création du lien de menu "API" et de la vue correspondante
Les SmartDocs du portail des développeurs sont désormais fournis par défaut avec un lien vers la documentation générée par SmartDocs dans le menu principal intitulé "API", qui redirige vers tous les modèles avec des méthodes publiées.

Problèmes connus

Cette version présente les problèmes connus suivants:

ID du problème Description
DEVSOL-1558
Les pages de méthode SmartDocs de l'exemple Petstore ne s'affichent pas correctement lors d'une nouvelle installation
Les exemples de pages de méthode Petstore dans SmartDocs ne s'affichent pas correctement lors d'une nouvelle installation. Pour résoudre ce problème :
  1. Sélectionnez Contenu > SmartDocs dans le menu Drupal.
  2. Sélectionnez le modèle "Exemple de magasin pour animaux de compagnie".
  3. Sous Options de mise à jour, sélectionnez Afficher et publier les nœuds.
  4. Cochez la case Tout sélectionner / Désélectionner pour sélectionner tous les nœuds.
  5. Cliquez sur Mettre à jour.

Les nœuds devraient maintenant s'afficher correctement.