15.05.27.00: Notas de la versión del portal de servicios para desarrolladores de Apigee

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X.
info

El martes 2 de junio de 2015, lanzamos una nueva versión en la nube del portal de servicios para desarrolladores de Apigee.

Si tienes preguntas, visita la Asistencia al cliente de Apigee.

Para obtener una lista de todas las notas de la versión de Apigee Edge, consulta Notas de la versión de Apigee.

Nuevas funciones

Disponibilidad general de SmartDocs

SmartDocs pasará de la versión beta a la disponibilidad general. Entre las actualizaciones y funciones nuevas, se incluyen las siguientes:

  • Compatibilidad con Swagger 2.0, incluida la importación por archivo o URL, y compatibilidad con objetos de seguridad con nombres personalizados.
  • Mejoras en el diseño visual de las plantillas que generan SmartDocs.
  • Mejoras en la usabilidad y el flujo de trabajo del portal para desarrolladores, disponibles en el menú Contenido > SmartDocs de Drupal
  • Lo que se conocía como autenticación de "token personalizado" ahora se denomina "clave de API".
  • Objetos de "seguridad" de autenticación definidos a nivel de la revisión
  • Configuración de la autenticación del cliente a nivel de la plantilla Las revisiones nuevas ya no restablecen ninguna credencial de cliente de SmartDocs preconfigurada.

Para obtener más descripciones de las funciones, consulta esta entrada de blog.

Para obtener documentación de SmartDocs, consulta Cómo usar SmartDocs para documentar APIs.

Proceso de actualización de SmartDocs

Si ya usaste SmartDocs durante el período de la versión beta, las funciones y capacidades nuevas de la versión de disponibilidad general requieren que actualices SmartDocs en tu portal de desarrollador.

Las páginas de SmartDocs que ya se hayan publicado en tu portal para desarrolladores seguirán funcionando, pero debes seguir el proceso de actualización antes de editar o publicar cambios en páginas existentes o nuevas.

Ten en cuenta que, si bien puedes renderizar y publicar SmartDocs en tu portal para desarrolladores, estos se generan a partir del modelo de API que se encuentra en los servicios de administración de APIs de Edge de Apigee. Cualquier cambio que realices en un modelo de API en Edge será el mismo en todos tus entornos de Pantheon (similar a la forma en que los desarrolladores existen en todos los entornos de Pantheon).

Cómo actualizar de la versión beta de SmartDocs a la versión general

  1. Actualiza y prueba la versión 15.05.27 en tus entornos de dev o prueba en Pantheon.
  2. Crea un modelo nuevo para reemplazar cualquier modelo de API existente que hayas estado usando.
    • Si has estado importando documentos Swagger o WADL, vuelve a importarlos en una revisión nueva.
    • Si has estado manteniendo tu modelo de API a través del módulo de SmartDocs, expórtalo como JSON de SmartDocs y, luego, impórtalo a tu modelo nuevo con el archivo adjunto.
  3. Establece las propiedades de seguridad de la revisión de tu modelo. En la página Contenido > SmartDocs > modelo, selecciona Configuración de seguridad.
  4. Para verificar la autenticación preconfigurada en la página de configuración del modelo (Contenido > SmartDocs), haz clic en Configuración en la columna Operaciones.
  5. Actualiza las plantillas personalizadas para usar la versión 6 de los recursos de CSS y JS, y realiza cambios para reflejar los nombres de objetos nuevos, como authSchemes y apiSchema. Para obtener información sobre cómo actualizar las plantillas de SmartDocs, consulta Cómo usar SmartDocs para documentar APIs.
  6. Vuelve a renderizar y publica la revisión del modelo.
  7. Después de validar la nueva documentación, actualiza tu portal de producción a la versión 15.05.27.

Si eres cliente empresarial de Edge y tienes preguntas o inquietudes sobre el proceso de actualización, envía un correo electrónico a marsh@apigee.com y cnovak@apigee.com. De lo contrario, usa la comunidad de Apigee para obtener la mejor respuesta.

Fallas corregidas

En esta versión, se corrigieron los siguientes errores.

ID del problema Descripción
DEVSOL-487 Los administradores deben poder configurar el formato de día en Monetización
Ahora puedes configurar el formato de fecha en Monetización, en la configuración de monetización, para los formatos de fecha de Europa y EE.UU.
DEVSOL-603 La página del plan en conflicto tiene un formato incorrecto
Cuando se compra un plan que se superpone con uno existente, la página que se muestra ahora tiene un formato agradable para el usuario.
DEVSOL-642 Cómo mover la configuración a nivel del cliente de la configuración de seguridad a la configuración de la plantilla
DEVSOL-709 SmartDocs: El parámetro de plantilla de URL no se puede editar después de enviar una solicitud con un valor vacío
Se corrigió el problema que hacía que los parámetros de plantilla no se pudieran editar después de enviar la solicitud desde SmartDocs después de borrar el parámetro de plantilla en la documentación del método.
DEVSOL-1013 Se podrán editar las direcciones de correo electrónico de los usuarios del portal para desarrolladores
El campo de dirección de correo electrónico en la página de edición de perfil ya no estará inhabilitado y los desarrolladores podrán cambiar sus direcciones de correo electrónico.
DEVSOL-1273 “DevConnect Mint” aparece dos veces en la lista de módulos
En Módulos, se mostraba “Dev Connect Mint” dos veces. Ya se corrigió ese error.
DEVSOL-1313 Compatibilidad con la importación de archivos JSON/YAML o URLs para Swagger y WADL
Ahora se pueden importar archivos WADL a través de URLs y subir archivos Swagger.
DEVSOL-1339 Cambio de ubicación del menú Administrador de SmartDocs
Ahora SmartDocs se encuentra en el menú Contenido, y la configuración de SmartDocs se encuentra en el menú Administrador de configuración.
DEVSOL-1340 Quita la versión beta cuando vayas a GA
SmartDocs ahora se encuentra en el menú de contenido, y la configuración de SmartDocs se encuentra en el menú de configuración del administrador.
DEVSOL-1390 Se actualizó la biblioteca de PHP SDK Edge para corregir el problema de llamar a __toString().
Se actualizó la biblioteca de PHP SDK Edge para corregir el problema de llamar a __toString() en el objeto DeveloperRatePlan, que generaba este error: {quote} Error fatal: Llamada a una función miembro format() en un objeto no válido en /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php en la línea 221 {quote}. Este es un error que solo afecta a los clientes de Monetización con código personalizado que llama al método toString().
DEVSOL-1398 Se importó el modelo de Petstore de SmartDocs en la instalación sin solicitarle al usuario
Ahora, SmartDocs importa el ejemplo de Petstore Swagger durante la instalación del sitio (http://petstore.swagger.io/v2/swagger.json) en lugar del modelo del clima para tener un ejemplo más exhaustivo del uso de SmartDocs.
DEVSOL-1407 Cron falla cuando hay muchos desarrolladores
Cuando se ejecutaba cron de Drupal, una gran cantidad de desarrolladores causó un problema de tiempo de espera. Cuando una organización tiene más de 200 usuarios, ahora se usa un proceso por lotes.
DEVSOL-1470 Crea el vínculo del menú "APIs" y la vista correspondiente
Ahora, el portal para desarrolladores de SmartDocs incluye de forma predeterminada un vínculo a la documentación renderizada de SmartDocs en el menú principal llamado "APIs", que vincula a cualquier modelo con métodos publicados.

Problemas conocidos

Esta versión contiene los siguientes problemas conocidos:

ID del problema Descripción
DEVSOL-1558
Las páginas de métodos de SmartDocs del ejemplo de Petstore no se renderizan correctamente en una instalación nueva
Las páginas de métodos de Petstore de ejemplo en SmartDocs no se renderizan correctamente en una instalación nueva. Para solucionar este problema, haz lo siguiente:
  1. Selecciona Contenido > SmartDocs en el menú de Drupal.
  2. Selecciona el modelo "Petstore Example".
  3. Selecciona Renderizar y publicar nodos en Opciones de actualización.
  4. Haz clic en la casilla de verificación Seleccionar / anular la selección de todo para seleccionar todos los nodos.
  5. Haz clic en Actualizar.

Los nodos deberían renderizarse correctamente ahora.