Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
Во вторник, 2 июня 2015 г., мы выпустили новую облачную версию портала услуг разработчиков Apigee.
Если у вас есть вопросы, обратитесь в службу поддержки клиентов Apigee .
Список всех примечаний к выпуску 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, экспортируйте ее в формате SmartDocs JSON и импортируйте в новую модель, используя вложение файла.
- Установите свойства безопасности версии вашей модели. На странице Содержимое > SmartDocs > модель выберите Настройки безопасности .
- Проверьте любую предварительно настроенную аутентификацию на странице настроек модели ( Содержимое > SmartDocs ), нажав «Настройки» в столбце «Операции».
- Обновите все пользовательские шаблоны, чтобы использовать ресурсы CSS и JS версии 6, и внесите изменения, отражающие любые новые имена объектов, такие как authSchemes и apiSchema. Информацию об обновлении шаблонов SmartDocs см. в разделе «Использование SmartDocs для документирования API» .
- Выполните повторную визуализацию и опубликуйте версию модели.
- После проверки новой документации обновите рабочий портал до версии 15.05.27.
Если вы являетесь корпоративным клиентом Edge и у вас есть вопросы или сомнения по поводу процесса обновления, отправьте электронное письмо по адресу marsh@apigee.com и cnovak@apigee.com. В противном случае, пожалуйста, используйте сообщество Apigee для получения наилучшего ответа.
Исправлены ошибки
В этом выпуске исправлены следующие ошибки.
Идентификатор проблемы | Описание |
---|---|
ДЕВСОЛ-487 | Формат дня в монетизации должен настраивать администраторы. Формат даты теперь можно настроить в разделе «Монетизация» в настройках монетизации для форматов даты в Европе и США. |
ДЕВСОЛ-603 | Страница «План конфликта» плохо отформатирована При покупке плана, который пересекается с существующим планом, отображаемая страница теперь имеет удобный формат для пользователя. |
ДЕВСОЛ-642 | Переместите конфигурации уровня клиента из настроек безопасности в настройки шаблона. |
ДЕВСОЛ-709 | SmartDocs: параметр шаблона URL-адреса недоступен для редактирования после отправки запроса с пустым значением Устраняет проблему, из-за которой параметры шаблона становятся недоступными для редактирования после отправки запроса из SmartDocs после удаления параметра шаблона в документации метода. |
ДЕВСОЛ-1013 | Сделайте адреса электронной почты пользователей портала разработки доступными для редактирования. Поле адреса электронной почты на странице редактирования профиля больше не будет отключено, и разработчики смогут изменить свои адреса электронной почты. |
ДЕВСОЛ-1273 | «DevConnect Mint» дважды отображается в списке модулей. В разделе «Модули» дважды отображалось «Dev Connect Mint». Теперь это исправлено. |
ДЕВСОЛ-1313 | Поддержка импорта файлов JSON/YAML или URL-адресов для Swagger и WADL. Файлы WADL теперь можно импортировать через URL-адрес, а файлы Swagger можно загружать. |
ДЕВСОЛ-1339 | Изменение местоположения меню администратора SmartDocs SmartDocs теперь находится в меню контента, а настройки SmartDocs — в меню администратора настроек. |
ДЕВСОЛ-1340 | Удалить бета-версию при переходе в GA SmartDocs теперь находится в меню контента, а настройки SmartDocs — в меню администратора настроек. |
ДЕВСОЛ-1390 | Библиотека PHP SDK Edge была обновлена, чтобы устранить проблему с вызовом __toString(). Библиотека PHP SDK Edge была обновлена, чтобы устранить проблему вызова __toString() для объекта DeveloperRatePlan, которая создает следующую ошибку: {quote} Неустранимая ошибка: вызов функции-члена format() для объекта, не являющегося объектом в /Applications/MAMP. /htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php в строке 221 {quote} Это ошибка, которая затрагивает только клиентов монетизации с собственным кодом, вызывающим toString( ) метод. |
ДЕВСОЛ-1398 | Модель SmartDocs Petstore импортируется при установке без запроса пользователя. SmartDocs теперь импортирует пример разворота зоомагазина во время установки сайта (http://petstore.swagger.io/v2/swagger.json) вместо модели погоды, чтобы иметь более исчерпывающий пример использования SmartDocs. |
ДЕВСОЛ-1407 | Cron не работает, когда разработчиков много При запуске Drupal cron у большого количества разработчиков возникла проблема с тайм-аутом. Если в организации более 200 пользователей, теперь используется пакетный процесс. |
ДЕВСОЛ-1470 | Создать ссылку на меню «API» и соответствующий вид. Портал разработки SmartDocs теперь по умолчанию поставляется со ссылкой на отображаемую документацию SmartDocs в главном меню под названием «API», которая ссылается на любые модели с опубликованными методами. |
Известные проблемы
Этот выпуск содержит следующие известные проблемы:
Идентификатор проблемы | Описание |
---|---|
ДЕВСОЛ-1558 | Пример Petstore. Страницы методов SmartDocs не отображаются правильно при новой установке. Примеры страниц методов Petstore в SmartDocs отображаются неправильно при новой установке. Чтобы устранить эту проблему:
Теперь узлы должны отображаться правильно. |