15.05.27.00 - Apigee Developer Services Portal Release Notes

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

2 июня 2015 г. мы выпустили новую облачную версию портала сервисов для разработчиков Apigee.

Если у вас возникли вопросы, обратитесь в службу поддержки Apigee Edge.

Список всех примечаний к выпуску Apigee Edge приведен на странице Примечания к выпуску Apigee.

Новые функции

Общая доступность SmartDocs

Функция SmartDocs переходит из бета-версии в общую доступность. Обновления и новые функции:

  • Поддержка Swagger 2.0, в том числе импорт по файлу или URL, а также поддержка объектов безопасности с пользовательскими названиями.
  • Улучшения визуального дизайна в шаблонах, на основе которых создаются умные документы.
  • Улучшения удобства использования и рабочего процесса на портале для разработчиков, доступные через меню "Контент > SmartDocs" в Drupal.
  • Аутентификация с помощью специального токена теперь называется аутентификацией с помощью ключа API.
  • Объекты аутентификации "security", определенные на уровне версии.
  • Настройка аутентификации клиента на уровне шаблона. Новые версии больше не сбрасывают предварительно настроенные учетные данные клиента SmartDocs.

Подробнее о функциях рассказывается в записи в блоге.

Документацию по SmartDocs можно найти в статье Как использовать SmartDocs для документирования API.

Процесс обновления SmartDocs

Если вы уже использовали SmartDocs в бета-версии, то для доступа к новым функциям и возможностям версии с общей доступностью вам нужно обновить SmartDocs на портале разработчика.

Все страницы SmartDocs, которые уже опубликованы на вашем портале для разработчиков, будут работать и дальше, но перед тем как редактировать или публиковать изменения на существующих или новых страницах, необходимо выполнить описанные ниже действия.

Обратите внимание, что, хотя вы можете отрисовывать и публиковать SmartDocs на своем портале для разработчиков, они генерируются на основе модели API, которая находится в сервисах управления API Apigee Edge. Все изменения, внесенные в модель API в Edge, будут одинаковыми во всех средах Pantheon (по аналогии с тем, как разработчики существуют в средах Pantheon).

Как перейти с бета-версии SmartDocs на общую доступность

  1. Обновите и протестируйте версию 15.05.27 в разработочной или тестовой среде на платформе Pantheon.
  2. Создайте новую модель, чтобы заменить существующую модель API.
    • Если вы импортировали документы Swagger или WADL, импортируйте их снова в новую версию.
    • Если вы поддерживали модель API с помощью модуля SmartDocs, экспортируйте ее как JSON SmartDocs и импортируйте в новую модель, используя прикрепленный файл.
  3. Задайте свойства безопасности для версии модели. На странице Контент > SmartDocs > модель выберите Настройки безопасности.
  4. Проверьте предварительно настроенную аутентификацию на странице настроек модели (Контент > SmartDocs), нажав Настройки в столбце "Операции".
  5. Обновите все собственные шаблоны, чтобы в них использовались объекты CSS и JS версии 6, а также внесите изменения, связанные с новыми названиями объектов, например authSchemes и apiSchema. Информацию о том, как обновить шаблоны SmartDocs, можно найти в статье Как использовать SmartDocs для документирования API.
  6. Заново отрисуйте и опубликуйте измененную модель.
  7. После проверки новой документации обновите рабочий портал до версии 15.05.27.

Если вы корпоративный клиент Edge и у вас есть вопросы или проблемы, связанные с процессом обновления, отправьте электронное письмо на адрес marsh@apigee.com и cnovak@apigee.com. В остальных случаях рекомендуем обратиться к сообществу Apigee.

Исправлены ошибки

В этой версии исправлены следующие ошибки:

Идентификатор проблемы Описание
DEVSOL-487 Формат даты в разделе "Монетизация" должен настраиваться администраторами
Теперь формат даты можно настроить в разделе "Монетизация" в настройках монетизации для европейского и американского форматов.
DEVSOL-603 Некорректное форматирование страницы "План конфликта"
Теперь при покупке плана, который пересекается с существующим, страница отображается корректно.
DEVSOL-642 Перенос конфигураций на уровне клиента из настроек безопасности в настройки шаблона
DEVSOL-709 SmartDocs: параметр шаблона URL нельзя изменить после отправки запроса с пустым значением
Исправлена проблема, из-за которой параметры шаблона нельзя было изменить после отправки запроса из SmartDocs после удаления параметра шаблона в документации метода.
DEVSOL-1013 Разрешить редактировать адреса электронной почты пользователей на портале разработчика
Поле адреса электронной почты на странице редактирования профиля больше не будет отключено, и разработчики смогут изменять свои адреса электронной почты.
DEVSOL-1273 В списке модулей дважды указан "DevConnect Mint"
В разделе "Модули" дважды указан "DevConnect Mint". Теперь эта неполадка устранена.
DEVSOL-1313 Поддержка импорта файлов JSON/YAML или URL для Swagger и WADL
Теперь файлы WADL можно импортировать через URL, а файлы Swagger – загружать.
DEVSOL-1339 Изменение местоположения меню администратора SmartDocs
Теперь SmartDocs находится в меню контента, а настройки SmartDocs – в меню администратора настроек.
DEVSOL-1340 Удаление бета-версии при переходе на общедоступную версию
Теперь SmartDocs находится в меню контента, а настройки SmartDocs – в меню настроек администратора.
DEVSOL-1390 Библиотека PHP SDK Edge обновлена, чтобы исправить проблему с вызовом __toString()
Библиотека PHP SDK Edge обновлена, чтобы исправить проблему с вызовом __toString() для объекта DeveloperRatePlan, из-за чего возникала следующая ошибка: {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} Это ошибка, которая затрагивает только клиентов, использующих монетизацию и собственный код, вызывающий метод toString().
DEVSOL-1398 Модель SmartDocs Petstore импортируется при установке без запроса пользователя
Теперь SmartDocs импортирует пример swagger petstore во время установки сайта (http://petstore.swagger.io/v2/swagger.json) вместо модели погоды, чтобы предоставить более полный пример использования SmartDocs.
DEVSOL-1407 Сбой Cron при большом количестве разработчиков
При запуске cron Drupal большое количество разработчиков привело к превышению времени ожидания. Если в организации больше 200 пользователей, теперь используется пакетная обработка.
DEVSOL-1470 Создание ссылки на меню "API" и соответствующего представления
Теперь в Dev Portal SmartDocs по умолчанию есть ссылка на документацию SmartDocs в главном меню под названием "API". Она ведет на любые модели с опубликованными методами.

Известные проблемы

В этой версии есть следующие известные проблемы:

Идентификатор проблемы Описание
DEVSOL-1558
Страницы методов Petstore Example SmartDocs неправильно отображаются при новой установке
При новой установке примеры страниц методов Petstore в SmartDocs отображаются некорректно. Вот как устранить проблему:
  1. В меню Drupal выберите Content (Контент) > SmartDocs.
  2. Выберите модель Petstore Example.
  3. В разделе Параметры обновления выберите Отрисовка и публикация узлов.
  4. Установите флажок Выбрать все, чтобы выбрать все узлы.
  5. Нажмите Обновить.

Теперь узлы должны отображаться правильно.