Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
Примеры API Apigee Edge содержат примеры прокси-серверов API, политики, код и инструменты, которые иллюстрируют возможности служб API Apigee Edge, описанных ниже.
Инструкции по использованию примеров см. в разделе Использование примеров прокси-серверов API .
Учитесь, делая
Хотите поскорее запачкать руки и начать создавать прочную базу знаний об Apigee Edge? У нас есть библиотека «обучающих» примеров на GitHub, которая позволяет быстро развертывать, вызывать и отслеживать некоторые примеры прокси, начиная с самого простого прокси и переходя к прокси, иллюстрирующим проверку ключей API, квоту, кэширование ответов, ошибки. обработка и многое другое.
После клонирования репозитория и настройки среды (это займет всего несколько минут) вы сможете опробовать каждый образец менее чем за минуту . А поскольку каждый образец создает новую версию одного и того же прокси-сервера, ваша среда не будет загромождена большим количеством образцов. Вы можете переключать версии, повторно развертывать другую версию в пользовательском интерфейсе управления и просматривать прокси-код в любое время. Файл readme для каждого примера также дает вам краткое описание того, что делает образец и как он настроен.
Попробуйте! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Образцы кулинарной книги доктора
Набор примеров предоставляется по темам кулинарной книги прокси-сервера API.
| Имя | Описание | Типы политик | Ресурсы |
|---|---|---|---|
| кулинарная книга Javascript | Демонстрирует простой фрагмент кода JavaScript, который добавляет HTTP-заголовки из переменных, преобразует отчет о погоде в формате XML из JSON в XML и сокращает содержимое для мобильных клиентов. | минимизировать.js setHeaders.js | |
| Javascript-mashup-кулинарная книга | Полноценное приложение JavaScript, которое вызывает общедоступные API, объединяет результаты и генерирует расширенный ответ для клиентского приложения. (Примечание: этот прокси-сервер API реализует ту же функциональность, что и гибридная политика, демонстрируя, что одну и ту же проблему можно решить с помощью разных методов.) | Javascript | MashItUp.js |
| java-привет | Простое Java-выноска «Привет, мир». | JavaCallout | JavaHello.java |
| Java-поваренная книга | Преобразует содержимое ответа и заголовки в верхний регистр. | JavaCallout | ResponseUppercase.java |
| Java-свойства | Демонстрирует, как использовать свойства в выноске Java. | JavaCallout | JavaProperties.java |
| Java-ошибка | Демонстрирует шаблоны обработки ошибок, которые можно использовать в коде Java Callout. | JavaCallout | JavaError.java |
| политика-mashup-поваренная книга | Полноценное приложение, которое использует композицию политик для вызова двух общедоступных API, объединяет результаты и генерирует расширенный ответ для клиентского приложения. (Примечание: этот прокси-сервер API реализует ту же функциональность, что и javascript-mashup, демонстрируя, что одну и ту же проблему можно решить с помощью разных методов.) | НазначитьСообщение СервисВыноска Извлечь переменные Javascript XMLToJSON | ГенерироватьОтвет.js |
Примеры API-прокси
Следующие прокси-серверы API расположены на GitHub, где на страницах ознакомительных сведений представлены подробные описания примеров. Если вас интересует, как работает конкретная политика в образце, найдите интересующую вас политику в столбце «Типы политик» ниже, а затем щелкните имя образца в столбце «Имя». (Политики связаны с соответствующими справочными страницами в документации.)
Справочник и инструменты
Помимо примеров кулинарной книги документа и примеров прокси-серверов в таблицах выше, образцы Edge GitHub также содержат следующие ресурсы:
| Имя | Описание | Типы политик | Ресурсы |
|---|---|---|---|
| r egex-защита | Политика защиты от угроз с помощью регулярных выражений может защитить ваши серверные API и микросервисы от атак с использованием SQL-инъекций. | Н/Д | |
| oauth-проверка-ключ-секрет | Вы реализуете поток типа предоставления пароля OAuth. Вам необходимо проверить ключ и секрет клиента приложения на Edge, прежде чем обращаться к внешнему поставщику удостоверений для проверки учетных данных пользователя. | OAuthV2 и другие | Н/Д |
| сопоставление условий с образцом | Этот прокси позволяет легко опробовать и протестировать условные операторы в потоке прокси API. | НазначитьСообщение | Н/Д |
| объект доступа | Показывает, как получить профили объектов из хранилища данных Apigee Edge. | НазначитьСообщение Аксессентити Извлечь переменные | никто |
| апикей | Реализует простую проверку ключа API. | ПроверитьAPIKey НазначитьСообщение Квота | никто |
| асинхронный вызов | Демонстрирует простой асинхронный вызов с использованием JavaScript httpClient. | Javascript | assemble_response.js callout.js |
| кодировщик base64 | Демонстрирует, как вызывать включения JavaScript из ресурсов JavaScript в прокси-серверах API. | НазначитьСообщение Javascript | core-min.js enc-utf16-min.js enc-base64-min.js кодироватьAuthHeader.js |
| условная политика | Реализует простое принудительное применение условной политики. Когда запрос содержит заголовок HTTP responsetime:true, политика выполняет сценарий Python, который добавляет набор показателей производительности в ответное сообщение в виде заголовков HTTP. | Скрипт (Питон) | таймер.py |
| динамическая конечная точка | Реализует простую условную маршрутизацию в немного более сложном сценарии, в котором определяются два URL-адреса и один маршрут по умолчанию. | никто | никто |
| примечания к выпуску jira | Это прокси-сервер API, используемый командой документации Apigee для создания примечаний к выпуску из Jira. | JSONToXML XSL | Releasenotes_api.xsl |
| Kerberos-credential-посредник | В этом примере показано, как выполнить посредничество учетных данных Kerberos в Apigee Edge. | JavaCallout | Java-JAR-файл |
| oauth-продвинутый | Полный рабочий пример потока типов предоставления кода авторизации с Apigee Edge в качестве сервера авторизации. | Генерировать токен доступа Многие другие... | см. пример кода |
| oauth-клиент-учетные данные | Демонстрирует полнофункциональную конечную точку токена OAuth 2.0, настроенную для типа предоставления учетных данных клиента. | Генерировать токен доступа | никто |
| приложение для входа в систему oauth | Устарело. Вместо этого мы рекомендуем вам просмотреть расширенный образец oauth . | ||
| oauth-проверка-ключ-секрет | Иллюстрирует метод проверки ключа и секрета клиента перед вызовом поставщика удостоверений для проверки учетных данных пользователя в потоке типа предоставления пароля. | ОАутв2 НазначитьСообщение Извлечь переменные СервисВыноска RaiseFault | никто |
| oauth-verify-accesstoken | Демонстрирует прокси-сервер API, настроенный для проверки токенов доступа OAuth 2.0 и проверки квоты. | VerifyAccessToken Квота | никто |
| oauth10a-3ногий | Демонстрирует трехстороннюю конфигурацию OAuth 1.0a. | ГенерироватьAceessToken Генерировать токен запроса СервисВыноска VerifyAccessToken | никто |
| исходящая аутентификация | Использует API переводчика Microsoft Azure для перевода твитов. Для этого он выполняет исходящий вызов для получения токена доступа OAuth, а затем кэширует токен с помощью политик кэширования служб API, повторно используя кэшированный токен каждый раз, когда выполняется исходящий вызов. Кроме того, включает демонстрационное браузерное приложение, используемое для вызова прокси-сервера API. | НазначитьСообщение LookupCache Заполнить кэш Javascript | API-config.js API-токен-get.js переводчик-query.js переводчик-results.js |
| нумерация страниц | Разбивает ответное сообщение XML на страницы на основе параметров предела и смещения, предоставленных клиентом. | НазначитьСообщение Извлечь переменные ResponseCache VerifyApiKey XSL | paginate.xslt |
| кэш ответов | Демонстрирует, как кэшировать прогнозы погоды в Edge на 10 минут. | ResponseCache НазначитьСообщение | никто |
| простой Python | Демонстрирует простой сценарий подключения скрипта Python в ответ, который добавляет к нему значение заголовка. | Скрипт (Питон) | setHeader.py |
| мыло | Демонстрирует преобразование XSL, которое перезаписывает файл WSDL в ответ на запрос с параметром запроса ?wsdl. | НазначитьСообщение Извлечь переменные Скрипт (Питон) XSL | вычислитьадрес.py fixwsdl.xsl |
| потоковая передача | Демонстрирует конфигурацию потоковой передачи HTTP. | никто | никто |
| целевое перенаправление | Демонстрирует использование JavaScript для динамического выбора целевого URL-адреса на основе содержимого сообщения запроса. | Извлечь переменные Javascript | переписатьTargetUrl.js |
| twitter-mobile-хронология | Демонстрирует, как использовать JavaScript для удаления ненужных параметров из твитов, что приводит к упрощению временной шкалы Твиттера, удобной для мобильных устройств с ограниченными ресурсами. | НазначитьСообщение Javascript | MobileTimeline.js |
| Twitter-Oembed | Преобразует ответы временной шкалы (например, из statuses/user_timeline.json) в ответ oEmbed, который содержит данные временной шкалы в виде расширенного содержимого HTML. | НазначитьСообщение JavaScript | поиск-oembed.js |
| переменные | Демонстрирует, как извлекать и устанавливать переменные на основе содержимого транспорта и сообщений JSON и XML. | НазначитьСообщение Извлечь переменные XMLToJSON | минимизировать.js |
| xmltojson | Преобразует данные ответа из XML в JSON. | XMLToJSON JSONToXML | никто |
| Файлы схемы XML, которые можно использовать в качестве справочного материала при настройке прокси-серверов API, политик, продуктов API, а также профилей разработчиков и приложений. | ||
| Содержит инструмент развертывания Deploy.py, который импортирует прокси-сервер API в организацию в Apigee Edge, а затем развертывает его в указанной среде. | ||
| Инструмент моментальных снимков организации извлекает настройки организации, включая разработчиков, продукты API, виртуальные хосты, карты «ключ-значение» и т. д. Его можно использовать для резервного копирования сведений об организации или для обнаружения настроек в организации. |
Апигей-127
Если вы программист, Apigee-127 поможет вам кодировать прокси API с помощью Node.js и Swagger. Вы также можете найти образцы a127 на GitHub: https://github.com/apigee-127/a127-samples .
Поделитесь своим опытом
Поделитесь своим опытом на форуме разработчиков Apigee .