Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Во вторник, 2 июня 2015 года, мы выпустили новую облачную версию портала Apigee Developer Services Portal.
Если у вас возникли вопросы, обратитесь в службу поддержки Apigee Edge .
Список всех примечаний к выпуску Apigee Edge см. в разделе «Примечания к выпуску Apigee» .
Новые функции
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-603 | Страница «План действий в конфликтной ситуации» плохо отформатирована. При покупке тарифного плана, который частично совпадает с уже существующим, отображаемая страница теперь корректно отображается для пользователя. |
| DEVSOL-642 | Перенесите настройки клиентского уровня из параметров безопасности в параметры шаблона. |
| DEVSOL-709 | SmartDocs: Параметр шаблона URL недоступен для редактирования после отправки запроса с пустым значением. Исправлена ошибка, из-за которой параметры шаблона становились недоступными для редактирования после отправки запроса из SmartDocs после удаления параметра шаблона в документации метода. |
| DEVSOL-1013 | Сделайте адреса электронной почты пользователей портала разработчиков доступными для редактирования. Поле для ввода адреса электронной почты на странице редактирования профиля больше не будет отключено, и разработчики смогут изменять свои адреса электронной почты. |
| DEVSOL-1273 | Модуль "DevConnect Mint" встречается в списке модулей дважды. В разделе «Модули» название «Dev Connect 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, которая приводит к следующей ошибке: {цитата} Фатальная ошибка: вызов метода 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-1470 | Создайте ссылку в меню «API» и соответствующее представление. В Dev Portal SmartDocs теперь по умолчанию есть ссылка на отображаемую в SmartDocs документацию в главном меню под названием "API", которая ведет к любым моделям с опубликованными методами. |
Известные проблемы
В данной версии обнаружены следующие известные проблемы:
| Идентификатор выпуска | Описание |
|---|---|
| DEVSOL-1558 | Пример страницы метода SmartDocs для зоомагазина отображается некорректно при новой установке. Примеры страниц с описанием метода Petstore в SmartDocs некорректно отображаются при новой установке. Для решения этой проблемы:
Теперь узлы должны отображаться корректно. |