Вы просматриваете документацию 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, необходимо подключить его к версии 4.15.07.00 или более поздней, чтобы обеспечить поддержку всех функций SmartDocs. Подробнее см. в примечаниях к выпуску 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 внутри своего портала разработчика, они генерируются на основе модели 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 | Формат дня в монетизации должен настраиваться администраторами. Формат даты теперь можно настраивать в разделе «Монетизация» в настройках монетизации для европейских и американских форматов даты. |
| ДЕВСОЛ-584 | Параметр пути не запоминается при первом использовании Параметр пути при совершении вызовов не всегда запоминался. |
| ДЕВСОЛ-603 | Страница плана разрешения конфликтов плохо отформатирована При покупке плана, который пересекается с существующим планом, отображаемая страница теперь отформатирована удобным для пользователя образом. |
| ДЕВСОЛ-709 | SmartDocs: параметр шаблона URL не может быть отредактирован после отправки запроса с пустым значением Исправлена ошибка, из-за которой параметры шаблона становились недоступными для редактирования после отправки запроса из SmartDocs после удаления параметра шаблона в документации метода. |
| ДЕВСОЛ-723 | Показывать понятные сообщения об ошибках импорта SmartDocs |
| ДЕВСОЛ-1013 | Сделайте адреса электронной почты пользователей портала разработчиков редактируемыми Поле адреса электронной почты на странице редактирования профиля больше не будет отключено, и разработчики смогут изменять свои адреса электронной почты. |
| ДЕВСОЛ-1244 | Не включайте модуль индикатора среды для выпусков OPDK |
| ДЕВСОЛ-1273 | «DevConnect Mint» дважды отображается в списке модулей В разделе «Модули» дважды отображалось «Dev Connect Mint». Теперь это исправлено. |
| ДЕВСОЛ-1313 | Поддержка импорта файлов JSON/YAML или URL для Swagger и WADL Файлы WADL теперь можно импортировать через URL, а файлы Swagger можно загружать. |
| ДЕВСОЛ-1339 | Изменить расположение меню администратора SmartDocs SmartDocs теперь находится в меню содержимого, а настройки Smartdocs — в меню настроек администратора. |
| ДЕВСОЛ-1340 | Удалить бета-версию при переходе в GA |
| ДЕВСОЛ-1390 | Библиотека PHP SDK Edge обновлена для устранения проблемы вызова __toString(). Фатальная ошибка: вызов функции-члена 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 пользователей, теперь используется пакетная обработка. |
| ДЕВСОЛ-1410 | Ошибки подключения не видны при установке Dev Portal Добавлены улучшенные сообщения об ошибках в установщик, когда соединение Edge Management не работает, чтобы свести к минимуму проблемы с устранением неполадок. |
| ДЕВСОЛ-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() Они позволяют пользовательским модулям изменять диаграмму аналитики приложения разработчика. |
| ДЕВСОЛ-1464 | Фатальная ошибка при сохранении настроек аутентификации для модели При удалении схемы безопасности теперь появляется флажок, позволяющий выбрать, нужно ли также удалить связанную с ней схему аутентификации шаблона. |
| ДЕВСОЛ-1470 | Создать ссылку меню «API» и соответствующее представление Dev Portal SmartDocs теперь по умолчанию содержит ссылку на визуализированную документацию SmartDocs в главном меню под названием «API», которая ссылается на любые модели с опубликованными методами. |
| ДЕВСОЛ-1486 | Вызовы SmartDocs могут аутентифицироваться с помощью предопределенного ключа Обеспечивает аутентификацию как с помощью предварительно предоставленных, так и предоставленных пользователем ключей API. |
| ДЕВСОЛ-1499 | HTML-код не анализируется в описаниях параметров SmartDocs HTML-код теперь анализируется в описаниях параметров SmartDocs. |
| ДЕВСОЛ-1507 | Невозможно добавить несколько параметров в API с помощью метода «Добавить метод». Теперь при редактировании метода можно добавлять несколько параметров в API SmartDocs. |
| ДЕВСОЛ-1509 | Не вижу способа редактировать поле «образец» для API SmartDocs Теперь при редактировании страницы SmartDocs можно задать «Тип MIME тела», «Документацию тела» и «Пример тела». |
| ДЕВСОЛ-1534 | Тип содержимого не заполняется в выходных данных SmartDocs Тип содержимого теперь заполняется на странице методов SmartDocs. |
| ДЕВСОЛ-1554 | Неверное сравнение дат в монетизации На вкладке приобретенного плана для порталов разработчиков с поддержкой монетизации кнопка «Отмена» никогда не отображалась для плана с будущей датой начала. |
| ДЕВСОЛ-1556 | Старая версия модулей Drupal отправляется Модуль media_youtube и функции обновлен до последней версии. |
| ДЕВСОЛ-1558 | Страницы методов SmartDocs не отображаются для примера PetStore В новых установках примеры методов SmartDocs PetStore теперь отображаются правильно. |
| ДЕВСОЛ-1562 | Создать представление для каждой модели SmartDocs При создании новой модели по умолчанию создается новое представление для этой модели. |
| ДЕВСОЛ-1565 | Редактирование метода SmartDocs приводит к фатальной ошибке Исправлена ошибка, из-за которой редактирование метода SmartDocs иногда приводило к ошибке. |
| ДЕВСОЛ-1567 | «Добавить модель» отображается в верхнем меню администратора Исправлена проблема с отображением пункта меню «Добавить модель» в верхнем меню администратора. |
| ДЕВСОЛ-1576 | В представлении документации API отображается название модели, а не отображаемое имя На странице документации API, которая открывается при нажатии на пункт меню «API», отображалось внутреннее имя модели вместо отображаемого. Если вы обновляетесь до новой версии и изменили это представление, вам потребуется отменить его, чтобы увидеть эти изменения, выполнив следующие действия: # Войдите в систему как администратор # Перейдите в раздел «Структура» > «Представления» # Щелкните раскрывающийся список рядом с кнопкой «Изменить» в разделе «Модели SmartDocs», чтобы увидеть все операции. # Если вы видите «Вернуть», значит, вы перезаписали код своими изменениями. Нажмите «Вернуть», чтобы вернуть представление к состоянию по умолчанию. Обратите внимание, что это удалит все внесенные вами изменения. |
| ДЕВСОЛ-1578 | Рендеринг моделей Weather и Petstore на месте установки Модели Petstore и Weather SmartDocs импортируются на новые сайты. |
| ДЕВСОЛ-1584 | Планы не могут быть куплены Исправлена ошибка, из-за которой форма покупки планов монетизации не отправлялась для облачных версий 15.05.27.00 и 15.06.08.00, если вы использовали тему Apigee Responsive или подтему темы Apigee Responsive. |
| ДЕВСОЛ-1597 | Невозможно изменить настройки времени ожидания разработчика Исправлена ошибка, из-за которой настройки тайм-аута Edge-подключения применялись некорректно. |
| ДЕВСОЛ-1620 | Я, индикатор окружающей среды и обновления модуля функций https://www.drupal.org/project/me https://www.drupal.org/project/environment_indicator |
| ДЕВСОЛ-1648 | Убедитесь, что arg_separator.output равен '&', чтобы предотвратить сбой reCAPTCHA. Исправлена связанная с платформой ошибка, из-за которой не работала Google reCAPTCHA. |
| ДЕВСОЛ-1651 | Тема Apigee Base не работает, если модуль smartdocs не включен Тема apigee_base больше не зависит от включения модуля SmartDocs. |
| ДЕВСОЛ-1654 | Увеличьте версию admin_views, чтобы получить критически важное исправление безопасности
|