Вы просматриваете документацию Apigee Edge .
Перейти к документации Apigee X. info
Во вторник, 2 июня 2015 года, мы выпустили новую облачную версию портала Apigee Developer Services.
Если у вас возникнут вопросы, обратитесь в службу поддержки Apigee Edge .
Список всех примечаний к выпуску Apigee Edge см. в разделе Примечания к выпуску Apigee .
Новые функции
SmartDocs общедоступны
SmartDocs переходит из стадии бета-тестирования в стадию общедоступной версии. Обновления и новые функции включают:
- Поддержка Swagger 2.0, включая импорт по файлу или URL, включая поддержку именованных настраиваемых объектов безопасности.
- Улучшения визуального дизайна в шаблонах, формирующих SmartDocs.
- Улучшения удобства использования и рабочего процесса на портале разработчика, доступные через меню «Контент» > «SmartDocs» в Drupal.
- То, что раньше называлось аутентификацией с помощью «пользовательского токена», теперь называется «ключом API».
- Объекты «безопасности» аутентификации, определенные на уровне ревизии.
- Настройка аутентификации клиента на уровне шаблона. Новые версии больше не сбрасывают предварительно настроенные учётные данные клиента SmartDocs.
Более подробное описание функций смотрите в этой записи блога .
Документацию по SmartDocs см. в разделе Использование SmartDocs для документирования API .
Процесс обновления 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, которая приводит к следующей ошибке: {цитата} Фатальная ошибка: вызов функции-члена format() для не-объекта в /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php в строке 221 {цитата} Это ошибка, которая затрагивает только клиентов монетизации с пользовательским кодом, вызывающим метод toString(). |
| ДЕВСОЛ-1398 | Модель SmartDocs Petstore импортируется при установке без запроса на подтверждение от пользователя. SmartDocs теперь импортирует пример зоомагазина Swagger во время установки сайта (http://petstore.swagger.io/v2/swagger.json) вместо модели погоды, чтобы иметь более исчерпывающий пример использования SmartDocs. |
| ДЕВСОЛ-1407 | Cron дает сбой, когда разработчиков много При запуске cron в Drupal большое количество разработчиков приводило к тайм-ауту. Если в организации более 200 пользователей, теперь используется пакетная обработка. |
| ДЕВСОЛ-1470 | Создать ссылку меню «API» и соответствующее представление Dev Portal SmartDocs теперь по умолчанию содержит ссылку на визуализированную документацию SmartDocs в главном меню под названием «API», которая ссылается на любые модели с опубликованными методами. |
Известные проблемы
В этом выпуске содержатся следующие известные проблемы:
| Идентификатор выпуска | Описание |
|---|---|
| ДЕВСОЛ-1558 | Страницы методов SmartDocs для Petstore Example отображаются некорректно на новой установке. Примеры страниц методов Petstore в SmartDocs отображаются некорректно при новой установке. Чтобы исправить эту проблему:
Теперь узлы должны отображаться правильно. |