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

Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.

Le mardi 2 juin 2015, nous avons lancé une nouvelle version cloud du portail Apigee Developer Services.

Pour toute question, contactez l'assistance Apigee Edge.

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 :

  • Prise en charge de Swagger 2.0, y compris l'importation par fichier ou URL, et prise en charge des objets de sécurité personnalisés.
  • Améliorations de la conception visuelle dans les modèles qui génèrent 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 "security" 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 la documentation 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 de la version en disponibilité générale nécessitent que vous mettiez à niveau SmartDocs dans votre portail de développeur.

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

N'oubliez pas que, même si vous pouvez afficher et publier des documents 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 d'API Edge d'Apigee. Toutes les modifications que vous apportez à un modèle d'API dans Edge sont les mêmes dans tous vos environnements Pantheon (comme les développeurs dans les environnements Pantheon).

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

  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 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 JSON SmartDocs et 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 tous les modèles personnalisés pour utiliser 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 les modèles SmartDocs, consultez Utiliser SmartDocs pour documenter les API.
  6. Rendez à nouveau votre révision de modèle et publiez-la.
  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 du jour dans la section "Monétisation" doit être configurable par les administrateurs
Le format de la date est désormais configurable dans la section "Monétisation", sous les paramètres de monétisation, pour les formats de date européens et américains.
DEVSOL-603 La page "Plan en conflit" est mal mise en forme
Lorsque vous achetez un forfait qui chevauche un forfait existant, la page affichée est désormais mise en forme correctement 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 à partir de SmartDocs après la suppression du paramètre de modèle dans la documentation de la méthode.
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-1273 "DevConnect Mint" apparaît deux fois dans la liste des modules
Sous "Modules", "Dev Connect Mint" s'affiche deux fois. Ce problème est désormais résolu.
DEVSOL-1313 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 Modifier l'emplacement du menu "Admin" de SmartDocs
SmartDocs se trouve désormais dans le menu "Contenu", et les paramètres SmartDocs se trouvent dans le menu "Admin" des paramètres.
DEVSOL-1340 Supprimer la version bêta lors du passage à la version GA
SmartDocs se trouve désormais dans le menu "Contenu", et les paramètres SmartDocs se trouvent dans le menu d'administration des paramètres.
DEVSOL-1390 La bibliothèque Edge du SDK PHP a été mise à jour pour corriger le problème d'appel de __toString()
La bibliothèque Edge du SDK PHP a été mise à jour pour corriger le problème d'appel de __toString() sur l'objet DeveloperRatePlan, qui crée cette erreur : {quote} 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 {quote} Il s'agit d'un bug qui n'affecte que les clients de la monétisation avec un 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 de disposer d'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 Drupal Cron, un grand nombre de développeurs ont provoqué un problème de délai d'attente. Lorsqu'une organisation compte plus de 200 utilisateurs, un processus par lot est désormais utilisé.
DEVSOL-1470 Créer un lien de menu "API" et la vue correspondante
Le portail des développeurs SmartDocs est désormais fourni par défaut avec un lien vers la documentation SmartDocs affichée dans le menu principal, nommé "API", qui renvoie à 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éthodes SmartDocs de l'exemple Petstore ne s'affichent pas correctement lors d'une nouvelle installation
Les pages de méthodes Petstore dans SmartDocs ne s'affichent pas correctement lors d'une nouvelle installation. Pour résoudre ce problème :
  1. Dans le menu Drupal, sélectionnez Contenu > SmartDocs.
  2. Sélectionnez le modèle "Exemple de boutique d'animaux".
  3. Sélectionnez Render and publish nodes (Rendre et publier les nœuds) sous Update Options (Options de mise à jour).
  4. Cochez la case Sélectionner / Désélectionner tout pour sélectionner tous les nœuds.
  5. Cliquez sur Mettre à jour.

Les nœuds devraient maintenant s'afficher correctement.