Обзор публикации

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Публикация — это процесс предоставления ваших API разработчикам приложений для использования.

Видео: В следующем видеоролике представлено общее введение в публикацию API.

Публикация API включает в себя следующие задачи, описанные в этом разделе:

  1. Создайте в Edge продукты API, которые объединят ваши API.
  2. Зарегистрируйте разработчиков приложений в Edge.
  3. Регистрируйте приложения разработчиков в Edge.
  4. Обеспечьте документацию и поддержку сообщества для ваших API.

Задание 1: Создайте API-продукт в Edge.

Первая задача при публикации — создание API-продукта. API-продукт — это набор ресурсов API, предлагаемых разработчикам приложений в виде пакета для использования. Создавайте API-продукты с помощью API управления Edge или пользовательского интерфейса. (См. раздел «Что такое API-продукт?» для получения дополнительной информации об API-продуктах.)

Диаграмма последовательности слева направо, показывающая разработчика, приложение, API и бэкэнд-сервисы. Значок API и ресурсы выделены. Пунктирная линия указывает от разработчика к значку приложения, созданного разработчиком. Стрелки от приложения и обратно показывают поток запроса и ответа к значку API, при этом ключ приложения расположен над запросом. Значок API и ресурсы выделены. Под значком API находятся два набора путей к ресурсам, сгруппированных в два продукта API: продукт «Медиа» и продукт «Медиа». Продукт «Медиа» содержит ресурсы для /countries, /cities и /languages, а продукт «Медиа» содержит ресурсы для /books, /magazines и /movies. Справа от API находятся ресурсы бэкэнда, к которым обращается API, включая базу данных, корпоративную сервисную шину, серверы приложений и универсальный бэкэнд.

На этом рисунке API состоит из двух продуктов, каждый из которых содержит три ресурса API.

Как поставщик API, вы несете ответственность за создание API и API-продуктов для обработки контроля доступа, ограничений использования и любых других бизнес-требований. Например, вы можете:

  • Выпустите бесплатный API-продукт, предоставляющий доступ к ресурсам API только для чтения.
  • Выпустить второй API-продукт по низкой цене, который обеспечит доступ на чтение/запись к тем же ресурсам API, что и бесплатная версия, но с низким лимитом доступа, например, 1000 запросов в день.
  • Выпустить третий API-продукт по более высокой цене, который позволит осуществлять доступ на чтение/запись к тому же API-ресурсу, но с высоким лимитом доступа.

Важно помнить, что Edge предоставляет вам гибкость в создании API-продуктов, соответствующих бизнес-требованиям ваших API.

Для получения дополнительной информации о создании API-продуктов см. раздел «Создание API-продуктов» .

Задание 2: Зарегистрируйте разработчика приложений в Edge.

Разработчик создает приложения, которые используют ваши API. Перед регистрацией своего приложения разработчик регистрируется в Apigee Edge. После регистрации он получает ключ API, который предоставляет приложению доступ к API.

В процессе регистрации приложения вы контролируете, кто имеет доступ к вашим API. В любой момент вы можете удалить разработчика приложения, что аннулирует все связанные с ним ключи API и, следовательно, лишит его доступа к вашим API.

Диаграмма последовательности слева направо, показывающая разработчика, приложение, API и бэкэнд-сервисы. Значок разработчика выделен. Пунктирная линия указывает от выделенного разработчика к значку приложения, созданного разработчиком. Стрелки от приложения и обратно показывают поток запроса и ответа к значку API, при этом ключ приложения расположен над запросом. Под значком API находятся два набора путей к ресурсам, сгруппированных в два продукта API: продукт «Медиа» и продукт «Медиа». Продукт «Медиа» содержит ресурсы для /countries, /cities и /languages, а продукт «Медиа» — ресурсы для /books, /magazines и /movies. Справа от API находятся ресурсы бэкэнда, к которым обращается API, включая базу данных, корпоративную сервисную шину, серверы приложений и универсальный бэкэнд.

Как поставщик API, вы сами решаете, как регистрировать разработчиков. Например, вы можете использовать ручную регистрацию, при которой потенциальному разработчику необходимо связаться с вашей организацией для регистрации. Потенциальный разработчик должен предоставить всю необходимую информацию, такую ​​как адрес электронной почты, имя и фамилия, а также название компании. Если вы одобрите запрос разработчика, вы можете использовать пользовательский интерфейс управления Edge для ручной регистрации разработчика. Подробнее см. раздел «Управление разработчиками приложений» .

Apigee также предоставляет инструменты, которые можно использовать для автоматизации процесса регистрации разработчиков. Например:

  • Используйте API управления Apigee Edge для интеграции функциональности регистрации в ваш существующий веб-сайт. API управления Edge — это REST API, который вы можете использовать для выполнения всех аспектов процесса регистрации разработчиков. Подробнее см. в разделе «Использование API управления Edge для публикации API» .
  • Для регистрации разработчиков используйте портал Apigee Developer Services. Портал имеет встроенную поддержку регистрации разработчиков, а также множество других функций для поддержки ваших API. Подробнее см. в разделе «Что такое портал для разработчиков?» .

Задание 3: Зарегистрируйте приложение разработчика в Edge.

Прежде чем приложение сможет получить доступ к вашим API, оно должно быть зарегистрировано в Edge. Однако зарегистрировать приложение в Edge может только зарегистрированный разработчик.

Диаграмма последовательности слева направо, показывающая разработчика, приложение, API и бэкэнд-сервисы. Стрелки, указывающие на приложение, запрос/ответ и ключ API, выделены. Пунктирная линия указывает от разработчика к значку приложения, созданного разработчиком. Стрелки от и обратно к приложению показывают поток запроса и ответа к значку API, при этом ключ приложения расположен над запросом. Значок API и ресурсы выделены. Под значком API находятся два набора путей к ресурсам, сгруппированных в два продукта API: продукт «Медиа» и продукт «Медиа». Продукт «Медиа» содержит ресурсы для /countries, /cities и /languages, а продукт «Медиа» содержит ресурсы для /books, /magazines и /movies. Справа от API находятся ресурсы бэкэнда, к которым обращается API, включая базу данных, корпоративную сервисную шину, серверы приложений и универсальный бэкэнд.

При регистрации приложения разработчик выбирает один или несколько API-продуктов. Например, можно опубликовать несколько API-продуктов, соответствующих различным типам услуг и тарифным планам. Затем разработчик приложения может выбрать подходящий API-продукт из списка доступных.

В ответ на регистрацию приложения в Edge, Edge присваивает приложению уникальный API-ключ. Приложение должно передавать этот API-ключ в составе каждого запроса к API-ресурсу. Ключ проходит аутентификацию, и, если он действителен, запрос удовлетворяется. В любое время вы, как поставщик услуг, можете отозвать ключ, чтобы приложение больше не могло получать доступ к вашим API.

Как поставщик API, вы сами решаете, как регистрировать приложения. Вы можете:

  • Используйте ручной процесс, при котором разработчику необходимо связаться с вашей организацией для регистрации своего приложения. В ответ вы отправите разработчику ключ API, возможно, по электронной почте.
  • Используйте API управления Edge для интеграции функций регистрации приложений и доставки ключей в ваш веб-сайт.
  • Для платной учетной записи Edge используйте портал Apigee Developer Services, который имеет встроенную поддержку регистрации приложений и доставки ключей API.

Для получения дополнительной информации см. раздел «Регистрация приложений и управление ключами API» .

Задание 4: Задокументируйте свои API.

Важным аспектом публикации API-продуктов является предоставление документации и механизма обратной связи с разработчиками. Порталы для разработчиков с функциями социальной публикации все чаще используются для общения с сообществом разработчиков. Это включает в себя передачу статического контента, такого как документация по API и условия использования, а также динамического контента, создаваемого сообществом, например, блогов и форумов, а также функций поддержки клиентов.

Диаграмма последовательности слева направо, показывающая разработчика, приложение, API и бэкэнд-сервисы. Значок разработчика выделен. Под разработчиком находится блок, который представляет собой портал разработчика. Портал содержит документацию по API, примеры, учебные пособия, справочник по API и другие материалы. Портал также содержит блоги, форумы и портал поддержки. Пунктирная линия указывает от выделенного разработчика к значку приложения, которое разработчик создал. Стрелки от приложения и обратно показывают поток запроса и ответа к значку API, с ключом приложения, расположенным над запросом. Под значком API находятся два набора путей к ресурсам, сгруппированных в два продукта API: продукт «Медиа» и продукт «Медиа». Продукт «Медиа» содержит ресурсы для /countries, /cities и /languages, а продукт «Медиа» содержит ресурсы для /books, /magazines и /movies. Справа от API находятся ресурсы бэкэнда, к которым обращается API, включая базу данных, корпоративную сервисную шину, серверы приложений и универсальный бэкэнд.

Вы можете создать собственный веб-сайт для размещения документации или, если у вас есть платная учетная запись Edge, вы можете использовать портал Apigee Developer Services . Портал имеет встроенную поддержку документации, блогов, форумов и других типов контента, необходимых для поддержки вашего сообщества разработчиков.

SmartDocs позволяет документировать ваши API на портале Developer Services таким образом, чтобы документация по API была полностью интерактивной. Интерактивная документация с помощью SmartDocs означает, что пользователи портала могут:

  • Ознакомьтесь с информацией об API.
  • Отправьте запрос в реальном времени к API.
  • Просмотрите ответ, полученный от API в режиме реального времени.

Например, на следующем рисунке показан API, документированный на портале с помощью SmartDocs. Этот API предоставляет информацию о погоде для конкретного местоположения:

Метод SmartDocs API, позволяющий вызывать API погоды, нажав кнопку в этом методе. (в теме)

Разработчик вводит значение для параметра запроса 'w', чтобы указать местоположение, а затем нажимает кнопку «Отправить запрос» , чтобы увидеть запрос и ответ в реальном времени. Создав интерактивную документацию по вашим API, вы упрощаете пользователям портала изучение, тестирование и оценку ваших API.

API управления Edge — это REST API, позволяющий получать доступ к API-сервисам с помощью любого HTTP-клиента. Apigee использует SmartDocs для создания интерактивной документации по API управления Edge. Ознакомиться с документацией по API можно здесь .

Для получения дополнительной информации см. раздел «Использование SmartDocs для документирования API» .

,

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Публикация — это процесс предоставления ваших API разработчикам приложений для использования.

Видео: В следующем видеоролике представлено общее введение в публикацию API.

Публикация API включает в себя следующие задачи, описанные в этом разделе:

  1. Создайте в Edge продукты API, которые объединят ваши API.
  2. Зарегистрируйте разработчиков приложений в Edge.
  3. Регистрируйте приложения разработчиков в Edge.
  4. Обеспечьте документацию и поддержку сообщества для ваших API.

Задание 1: Создайте API-продукт в Edge.

Первая задача при публикации — создание API-продукта. API-продукт — это набор ресурсов API, предлагаемых разработчикам приложений в виде пакета для использования. Создавайте API-продукты с помощью API управления Edge или пользовательского интерфейса. (См. раздел «Что такое API-продукт?» для получения дополнительной информации об API-продуктах.)

Диаграмма последовательности слева направо, показывающая разработчика, приложение, API и бэкэнд-сервисы. Значок API и ресурсы выделены. Пунктирная линия указывает от разработчика к значку приложения, созданного разработчиком. Стрелки от приложения и обратно показывают поток запроса и ответа к значку API, при этом ключ приложения расположен над запросом. Значок API и ресурсы выделены. Под значком API находятся два набора путей к ресурсам, сгруппированных в два продукта API: продукт «Медиа» и продукт «Медиа». Продукт «Медиа» содержит ресурсы для /countries, /cities и /languages, а продукт «Медиа» содержит ресурсы для /books, /magazines и /movies. Справа от API находятся ресурсы бэкэнда, к которым обращается API, включая базу данных, корпоративную сервисную шину, серверы приложений и универсальный бэкэнд.

На этом рисунке API состоит из двух продуктов, каждый из которых содержит три ресурса API.

Как поставщик API, вы несете ответственность за создание API и API-продуктов для обработки контроля доступа, ограничений использования и любых других бизнес-требований. Например, вы можете:

  • Выпустите бесплатный API-продукт, предоставляющий доступ к ресурсам API только для чтения.
  • Выпустить второй API-продукт по низкой цене, который обеспечит доступ на чтение/запись к тем же ресурсам API, что и бесплатная версия, но с низким лимитом доступа, например, 1000 запросов в день.
  • Выпустить третий API-продукт по более высокой цене, который позволит осуществлять доступ на чтение/запись к тому же API-ресурсу, но с высоким лимитом доступа.

Важно помнить, что Edge предоставляет вам гибкость в создании API-продуктов, соответствующих бизнес-требованиям ваших API.

Для получения дополнительной информации о создании API-продуктов см. раздел «Создание API-продуктов» .

Задание 2: Зарегистрируйте разработчика приложений в Edge.

Разработчик создает приложения, которые используют ваши API. Перед регистрацией своего приложения разработчик регистрируется в Apigee Edge. После регистрации он получает ключ API, который предоставляет приложению доступ к API.

В процессе регистрации приложения вы контролируете, кто имеет доступ к вашим API. В любой момент вы можете удалить разработчика приложения, что аннулирует все связанные с ним ключи API и, следовательно, лишит его доступа к вашим API.

Диаграмма последовательности слева направо, показывающая разработчика, приложение, API и бэкэнд-сервисы. Значок разработчика выделен. Пунктирная линия указывает от выделенного разработчика к значку приложения, созданного разработчиком. Стрелки от приложения и обратно показывают поток запроса и ответа к значку API, при этом ключ приложения расположен над запросом. Под значком API находятся два набора путей к ресурсам, сгруппированных в два продукта API: продукт «Медиа» и продукт «Медиа». Продукт «Медиа» содержит ресурсы для /countries, /cities и /languages, а продукт «Медиа» — ресурсы для /books, /magazines и /movies. Справа от API находятся ресурсы бэкэнда, к которым обращается API, включая базу данных, корпоративную сервисную шину, серверы приложений и универсальный бэкэнд.

Как поставщик API, вы сами решаете, как регистрировать разработчиков. Например, вы можете использовать ручную регистрацию, при которой потенциальному разработчику необходимо связаться с вашей организацией для регистрации. Потенциальный разработчик должен предоставить всю необходимую информацию, такую ​​как адрес электронной почты, имя и фамилия, а также название компании. Если вы одобрите запрос разработчика, вы можете использовать пользовательский интерфейс управления Edge для ручной регистрации разработчика. Подробнее см. раздел «Управление разработчиками приложений» .

Apigee также предоставляет инструменты, которые можно использовать для автоматизации процесса регистрации разработчиков. Например:

  • Используйте API управления Apigee Edge для интеграции функциональности регистрации в ваш существующий веб-сайт. API управления Edge — это REST API, который вы можете использовать для выполнения всех аспектов процесса регистрации разработчиков. Подробнее см. в разделе «Использование API управления Edge для публикации API» .
  • Для регистрации разработчиков используйте портал Apigee Developer Services. Портал имеет встроенную поддержку регистрации разработчиков, а также множество других функций для поддержки ваших API. Подробнее см. в разделе «Что такое портал для разработчиков?» .

Задание 3: Зарегистрируйте приложение разработчика в Edge.

Прежде чем приложение сможет получить доступ к вашим API, оно должно быть зарегистрировано в Edge. Однако зарегистрировать приложение в Edge может только зарегистрированный разработчик.

Диаграмма последовательности слева направо, показывающая разработчика, приложение, API и бэкэнд-сервисы. Стрелки, указывающие на приложение, запрос/ответ и ключ API, выделены. Пунктирная линия указывает от разработчика к значку приложения, созданного разработчиком. Стрелки от и обратно к приложению показывают поток запроса и ответа к значку API, при этом ключ приложения расположен над запросом. Значок API и ресурсы выделены. Под значком API находятся два набора путей к ресурсам, сгруппированных в два продукта API: продукт «Медиа» и продукт «Медиа». Продукт «Медиа» содержит ресурсы для /countries, /cities и /languages, а продукт «Медиа» содержит ресурсы для /books, /magazines и /movies. Справа от API находятся ресурсы бэкэнда, к которым обращается API, включая базу данных, корпоративную сервисную шину, серверы приложений и универсальный бэкэнд.

При регистрации приложения разработчик выбирает один или несколько API-продуктов. Например, можно опубликовать несколько API-продуктов, соответствующих различным типам услуг и тарифным планам. Затем разработчик приложения может выбрать подходящий API-продукт из списка доступных.

В ответ на регистрацию приложения в Edge, Edge присваивает приложению уникальный API-ключ. Приложение должно передавать этот API-ключ в составе каждого запроса к API-ресурсу. Ключ проходит аутентификацию, и, если он действителен, запрос удовлетворяется. В любое время вы, как поставщик услуг, можете отозвать ключ, чтобы приложение больше не могло получать доступ к вашим API.

Как поставщик API, вы сами решаете, как регистрировать приложения. Вы можете:

  • Используйте ручной процесс, при котором разработчику необходимо связаться с вашей организацией для регистрации своего приложения. В ответ вы отправите разработчику ключ API, возможно, по электронной почте.
  • Используйте API управления Edge для интеграции функций регистрации приложений и доставки ключей в ваш веб-сайт.
  • Для платной учетной записи Edge используйте портал Apigee Developer Services, который имеет встроенную поддержку регистрации приложений и доставки ключей API.

Для получения дополнительной информации см. раздел «Регистрация приложений и управление ключами API» .

Задание 4: Задокументируйте свои API.

Важным аспектом публикации API-продуктов является предоставление документации и механизма обратной связи с разработчиками. Порталы для разработчиков с функциями социальной публикации все чаще используются для общения с сообществом разработчиков. Это включает в себя передачу статического контента, такого как документация по API и условия использования, а также динамического контента, создаваемого сообществом, например, блогов и форумов, а также функций поддержки клиентов.

Диаграмма последовательности слева направо, показывающая разработчика, приложение, API и бэкэнд-сервисы. Значок разработчика выделен. Под разработчиком находится блок, который представляет собой портал разработчика. Портал содержит документацию по API, примеры, учебные пособия, справочник по API и другие материалы. Портал также содержит блоги, форумы и портал поддержки. Пунктирная линия указывает от выделенного разработчика к значку приложения, которое разработчик создал. Стрелки от приложения и обратно показывают поток запроса и ответа к значку API, с ключом приложения, расположенным над запросом. Под значком API находятся два набора путей к ресурсам, сгруппированных в два продукта API: продукт «Медиа» и продукт «Медиа». Продукт «Медиа» содержит ресурсы для /countries, /cities и /languages, а продукт «Медиа» содержит ресурсы для /books, /magazines и /movies. Справа от API находятся ресурсы бэкэнда, к которым обращается API, включая базу данных, корпоративную сервисную шину, серверы приложений и универсальный бэкэнд.

Вы можете создать собственный веб-сайт для размещения документации или, если у вас есть платная учетная запись Edge, вы можете использовать портал Apigee Developer Services . Портал имеет встроенную поддержку документации, блогов, форумов и других типов контента, необходимых для поддержки вашего сообщества разработчиков.

SmartDocs позволяет документировать ваши API на портале Developer Services таким образом, чтобы документация по API была полностью интерактивной. Интерактивная документация с помощью SmartDocs означает, что пользователи портала могут:

  • Ознакомьтесь с информацией об API.
  • Отправьте запрос в реальном времени к API.
  • Просмотрите ответ, полученный от API в режиме реального времени.

Например, на следующем рисунке показан API, документированный на портале с помощью SmartDocs. Этот API предоставляет информацию о погоде для конкретного местоположения:

Метод SmartDocs API, позволяющий вызывать API погоды, нажав кнопку в этом методе. (в теме)

Разработчик вводит значение для параметра запроса 'w', чтобы указать местоположение, а затем нажимает кнопку «Отправить запрос» , чтобы увидеть запрос и ответ в реальном времени. Создав интерактивную документацию по вашим API, вы упрощаете пользователям портала изучение, тестирование и оценку ваших API.

API управления Edge — это REST API, позволяющий получать доступ к API-сервисам с помощью любого HTTP-клиента. Apigee использует SmartDocs для создания интерактивной документации по API управления Edge. Ознакомиться с документацией по API можно здесь .

Для получения дополнительной информации см. раздел «Использование SmartDocs для документирования API» .