Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Во вторник, 8 сентября 2015 года, мы выпустили ежеквартальную версию портала Apigee Edge Developer Services Portal для частного облака.
Прежнее название продукта "Apigee Edge On-premises Developer Services Portal" или "OPDK" теперь называется "Apigee Edge Developer Services Portal for Private Cloud".
Если у вас возникли вопросы, обратитесь в службу поддержки Apigee Edge .
Список всех примечаний к выпуску Apigee Edge см. в разделе «Примечания к выпуску Apigee» .
Требования Apigee Edge для портала
Если вы подключаете эту версию портала к установке Edge for Private Cloud, то для обеспечения поддержки всех функций SmartDocs необходимо подключиться к версии 4.15.07.00 или более поздней. Дополнительную информацию см. в примечаниях к выпуску 4.15.07.00 — Apigee Edge for Private Cloud .
Новые функции
SmartDocs доступен для общего использования.
SmartDocs переходит из стадии бета-тестирования в стадию общего доступа. Обновления и новые функции включают в себя:
- Поддержка Swagger 2.0, включая импорт по файлу или URL, а также поддержку объектов безопасности с пользовательскими именами.
- Улучшено визуальное оформление шаблонов, генерирующих документы SmartDocs.
- Улучшения удобства использования и оптимизации рабочих процессов на портале для разработчиков, доступном через меню «Контент > SmartDocs» в Drupal.
- То, что раньше называлось аутентификацией с помощью «пользовательского токена», теперь называется «ключом API».
- Объекты «безопасности» аутентификации определяются на уровне ревизии.
- Настройка аутентификации клиента на уровне шаблона. Новые версии больше не сбрасывают предварительно настроенные учетные данные клиента SmartDocs.
Более подробное описание функций см. в этой записи блога .
Документацию по SmartDocs см. в разделе «Использование SmartDocs для документирования API» .
процесс обновления SmartDocs
Если вы уже использовали SmartDocs в период бета-тестирования, для появления новых функций и возможностей в общедоступной версии потребуется обновить SmartDocs на портале разработчика.
Все страницы SmartDocs, уже опубликованные на вашем портале разработчика, будут продолжать работать, но перед редактированием или публикацией любых изменений на существующих или новых страницах необходимо выполнить процедуру обновления.
Имейте в виду, что хотя вы можете отображать и публиковать SmartDocs внутри своего портала разработчика, SmartDocs генерируются на основе модели API, которая находится в службах управления API Edge от Apigee. Любые изменения, внесенные вами в модель API в Edge, будут одинаковыми во всех ваших средах Pantheon (аналогично тому, как разработчики взаимодействуют между средами Pantheon).
Чтобы перейти с бета-версии SmartDocs на общедоступную версию
- Обновите и протестируйте релиз 15.05.27 в своих средах разработки или тестирования на Pantheon.
- Создайте новую модель, чтобы заменить любую существующую модель API, которую вы использовали ранее.
- Если вы импортировали документы Swagger или WADL, импортируйте их снова в новую версию.
- Если вы поддерживали свою модель API через модуль SmartDocs, экспортируйте ее в формате JSON SmartDocs и импортируйте в новую модель, прикрепив файл.
- Настройте параметры безопасности для версии вашей модели. На странице «Содержимое > SmartDocs > модель» выберите «Параметры безопасности» .

- Проверьте все предварительно настроенные методы аутентификации на странице настроек модели ( Содержание > SmartDocs ), нажав «Настройки» в столбце «Операции».

- Обновите все пользовательские шаблоны, чтобы использовать CSS и JS ресурсы версии 6, и внесите изменения, отражающие новые имена объектов, такие как authSchemes и apiSchema. Информацию об обновлении шаблонов SmartDocs см. в разделе «Использование SmartDocs для документирования API» .
- Повторно визуализируйте и опубликуйте свою обновленную модель.
- После проверки новой документации обновите свой производственный портал до версии 15.05.27.
Если вы являетесь корпоративным клиентом Edge и у вас есть вопросы или проблемы, связанные с процессом обновления, пожалуйста, напишите по электронной почте на адреса marsh@apigee.com и cnovak@apigee.com. В противном случае, пожалуйста, воспользуйтесь сообществом Apigee для получения наиболее полного ответа.
Исправлены ошибки
В этом релизе исправлены следующие ошибки.
| Идентификатор выпуска | Описание |
|---|---|
| DEVSOL-487 | Формат дня в системе монетизации должен быть доступен для настройки администраторами. Теперь формат даты можно настроить в разделе «Монетизация» в настройках монетизации для европейского и американского форматов даты. |
| DEVSOL-584 | Параметр пути не запоминается при первом использовании. Параметр пути при совершении звонков не всегда запоминался. |
| DEVSOL-603 | Страница «План действий в конфликтной ситуации» плохо отформатирована. При покупке тарифного плана, который частично совпадает с уже существующим, отображаемая страница теперь корректно отображается для пользователя. |
| DEVSOL-709 | SmartDocs: Параметр шаблона URL недоступен для редактирования после отправки запроса с пустым значением. Исправлена ошибка, из-за которой параметры шаблона становились недоступными для редактирования после отправки запроса из SmartDocs после удаления параметра шаблона в документации метода. |
| DEVSOL-723 | Отображать понятные для пользователя сообщения при ошибке импорта в SmartDocs |
| DEVSOL-1013 | Сделайте адреса электронной почты пользователей портала разработчиков доступными для редактирования. Поле для ввода адреса электронной почты на странице редактирования профиля больше не будет отключено, и разработчики смогут изменять свои адреса электронной почты. |
| ДЕВСОЛ-1244 | Не включайте модуль «Индикатор среды» для релизов OPDK. |
| DEVSOL-1273 | Модуль "DevConnect Mint" встречается в списке модулей дважды. В разделе «Модули» название «Dev Connect Mint» отображалось дважды. Теперь это исправлено. |
| DEVSOL-1313 | Поддерживается импорт файлов JSON/YAML или URL-адресов как для Swagger, так и для WADL. Теперь файлы WADL можно импортировать по URL-адресу, а файлы Swagger — загружать. |
| DEVSOL-1339 | Изменить расположение пунктов меню «Администрирование SmartDocs» Теперь SmartDocs находится в меню «Содержимое», а настройки SmartDocs — в меню администратора настроек. |
| DEVSOL-1340 | При переходе на общедоступную версию удалите бета-версию. |
| DEVSOL-1390 | В библиотеку PHP SDK Edge внесены изменения для исправления ошибки вызова метода __toString(). Фатальная ошибка: Вызов метода format() для объекта, не являющегося объектом, в файле /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php на строке 221 Это ошибка, затрагивающая только клиентов, использующих монетизацию и имеющих собственный код, вызывающий метод toString(). |
| DEVSOL-1398 | Модель зоомагазина SmartDocs импортируется при установке без запроса подтверждения у пользователя. Теперь SmartDocs импортирует пример Swagger для зоомагазина во время установки сайта ( http://petstore.swagger.io/v2/swagger.json ) вместо модели погоды, чтобы предоставить более полный пример использования SmartDocs. |
| DEVSOL-1407 | Cron не работает, когда много разработчиков. При использовании cron в Drupal большое количество разработчиков может привести к проблеме таймаута. В настоящее время, когда в организации более 200 пользователей, используется пакетная обработка. |
| DEVSOL-1410 | При установке Dev Portal ошибки подключения не наблюдаются. В установщик добавлено более информативное сообщение об ошибке, когда подключение к управлению Edge не работает, чтобы свести к минимуму проблемы, возникающие при устранении неполадок. |
| ДЕВСОЛ-1422 | Удалите форму настройки SMTP из профиля Apigee. В процессе установки больше не запрашивается разрешение на настройку SMTP; вместо этого это можно сделать после завершения установки, следуя стандартной практике Drupal, включающей включение модуля SMTP и его правильную настройку. |
| ДЕВСОЛ-1427 | Добавьте в модуль Devconnect Developer Apps механизмы для изменения аналитических данных. # hook_devconnect_developer_apps_analytics_chart_data_alter() # hook_devconnect_developer_app_analytics_datapoints_params_alter() # hook_devconnect_developer_app_analytics_datapoints_alter() Это позволяет пользовательским модулям изменять диаграмму аналитики приложения для разработчиков. |
| DEVSOL-1464 | Критическая ошибка при сохранении настроек аутентификации для модели. При удалении схемы безопасности теперь появляется флажок, позволяющий выбрать, нужно ли также удалить связанную с ней схему аутентификации по шаблону. |
| DEVSOL-1470 | Создайте ссылку в меню «API» и соответствующее представление. В Dev Portal SmartDocs теперь по умолчанию есть ссылка на отображаемую в SmartDocs документацию в главном меню под названием "API", которая ведет к любым моделям с опубликованными методами. |
| DEVSOL-1486 | Аутентификация вызовов SmartDocs может осуществляться с помощью предопределенного ключа. Обеспечивает аутентификацию как с использованием предварительно предоставленных, так и предоставленных пользователем ключей API. |
| DEVSOL-1499 | HTML-код не обрабатывается в описаниях параметров SmartDocs. Теперь HTML-код анализируется в описаниях параметров SmartDocs. |
| DEVSOL-1507 | Невозможно добавить несколько параметров в API с помощью метода Add. Теперь при редактировании метода SmartDocs можно добавлять несколько параметров к API. |
| DEVSOL-1509 | Не вижу способа отредактировать поле "образец" в API SmartDocs. Теперь при редактировании страницы SmartDocs можно задать «MIME-тип тела документа», «Документацию тела документа» и «Пример текста документа». |
| DEVSOL-1534 | В выходных данных SmartDocs не заполняется поле Content-Type. Теперь параметр Content-type заполняется на странице метода SmartDocs. |
| DEVSOL-1554 | Некорректное сравнение дат в монетизации На вкладке «Приобретенные тарифные планы» для порталов разработчиков с включенной монетизацией кнопка «Отмена» никогда не отображалась для тарифных планов с будущей датой начала действия. |
| DEVSOL-1556 | Поставляются старые версии модулей Drupal. Модуль media_youtube and features обновлен до последней версии. |
| DEVSOL-1558 | В примере с PetStore страницы, созданные с помощью метода SmartDocs, не отображаются. При новых установках примеры методов SmartDocs PetStore теперь отображаются корректно. |
| DEVSOL-1562 | Создайте представление для каждой модели SmartDocs. При создании новой модели по умолчанию для этой модели создается новое представление. |
| DEVSOL-1565 | При редактировании с помощью метода SmartDocs возникает фатальная ошибка. Исправлена ошибка, из-за которой редактирование метода SmartDocs иногда приводило к ошибке. |
| DEVSOL-1567 | В верхнем административном меню отображается кнопка «Добавить модель». Исправлена проблема, из-за которой пункт меню «Добавить модель» отображался в верхнем административном меню. |
| DEVSOL-1576 | В представлении документации API отображается имя модели, а не имя для отображения. На странице документации API, которая отображается при нажатии на «API» в меню, вместо отображаемого имени модели показывалось внутреннее имя модели. Если вы обновляете систему и изменили это представление, вам необходимо отменить изменения, выполнив следующие шаги: # Войдите в систему как администратор # Перейдите в раздел Структура > Представления # Щелкните раскрывающийся список рядом с «Редактировать» в разделе «Модели SmartDocs», чтобы увидеть все операции. # Если вы видите «Отменить», значит, вы перезаписали код своими изменениями. Нажмите «Отменить», чтобы вернуть представление в состояние по умолчанию. Обратите внимание, что это удалит все изменения, внесенные вами в это представление. |
| DEVSOL-1578 | Визуализируйте модели «Погода» и «Зоомагазин» при установке на объекте. Обе модели SmartDocs — Petstore и Weather — импортируются на новые сайты. |
| DEVSOL-1584 | Планы приобрести нельзя. Исправлена ошибка, из-за которой форма покупки планов монетизации не отправлялась для облачных версий 15.05.27.00 и 15.06.08.00, если вы использовали тему Apigee Responsive или её подтему. |
| DEVSOL-1597 | Невозможно изменить настройки таймаута разработчика. Исправлена ошибка, из-за которой настройки таймаута соединения Edge применялись некорректно. |
| DEVSOL-1620 | Обновления модуля «Я, индикатор окружающей среды и функциональные возможности» https://www.drupal.org/project/me https://www.drupal.org/project/environment_indicator |
| DEVSOL-1648 | Убедитесь, что arg_separator.output имеет значение '&', чтобы предотвратить сбой reCAPTCHA. Исправлена ошибка на платформе, из-за которой не работала Google reCAPTCHA. |
| ДЕВСОЛ-1651 | Тема Apigee Base не работает, если модуль smartdocs не включен. Тема apigee_base больше не зависит от включенного модуля SmartDocs. |
| DEVSOL-1654 | Обновлена версия admin_views для использования критического исправления безопасности.
|