Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
Публикация — это процесс предоставления ваших API-интерфейсов разработчикам приложений для использования.
Видео. В следующем видеоролике представлено общее представление о публикации API.
Публикация API включает в себя следующие задачи, описанные в этом разделе:
- Создавайте продукты API в Edge, которые объединяют ваши API.
- Зарегистрируйте разработчиков приложений в Edge.
- Зарегистрируйте приложения для разработчиков в Edge.
- Предоставляйте документацию и поддержку сообщества для ваших API.
Задача 1. Создайте продукт API в Edge
Первой задачей публикации является создание продукта API. Продукт API — это набор ресурсов API, которые предлагаются в виде пакета разработчикам приложений для использования. Создавайте продукты API с помощью API или пользовательского интерфейса управления Edge. (Чтобы узнать больше о продуктах 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 вы сами решаете, как регистрировать разработчиков. Например, вы можете использовать процесс регистрации вручную, при котором потенциальному разработчику потребуется связаться с вашей организацией для регистрации. Потенциальный разработчик должен предоставить всю необходимую информацию, такую как адрес электронной почты, имя и фамилию, а также название компании. Если вы одобрите запрос разработчика, вы сможете использовать пользовательский интерфейс управления Edge, чтобы вручную зарегистрировать разработчика. Дополнительные сведения см. в разделе «Управление разработчиками приложений» .
Apigee также предоставляет инструменты, которые можно использовать для автоматизации процесса регистрации разработчика. Например:
- Используйте API управления Apigee Edge для интеграции функций регистрации в существующий веб-сайт. API управления Edge — это REST API, который можно использовать для выполнения всех аспектов процесса регистрации разработчика. Дополнительные сведения см. в разделе Использование API управления Edge для публикации API .
- Используйте портал Apigee Developer Services для регистрации разработчиков. Портал имеет встроенную поддержку регистрации разработчиков, а также множество других функций для поддержки ваших API. См. раздел Что такое портал для разработчиков? для большего.
Задача 3. Зарегистрируйте приложение разработчика в Edge
Прежде чем приложение сможет получить доступ к вашим API, оно должно быть зарегистрировано в Edge. Однако только зарегистрированный разработчик может зарегистрировать приложение в Edge.
Во время регистрации приложения разработчик выбирает один или несколько продуктов API. Например, вы можете опубликовать несколько продуктов API, соответствующих различным типам услуг и тарифным планам. Затем разработчик приложения может выбирать из списка доступных продуктов API.
В ответ на регистрацию приложения в Edge Edge назначает приложению уникальный ключ API. Приложение должно передавать этот ключ API как часть каждого запроса к ресурсу API. Ключ аутентифицируется, и, если он действителен, запрос удовлетворяется. В любой момент вы как поставщик услуг можете отозвать ключ, чтобы приложение больше не могло получить доступ к вашим API.
Как поставщик API вы сами решаете, как регистрировать приложения. Вы могли бы:
- Используйте ручной процесс, который требует, чтобы разработчик связался с вашей организацией, чтобы зарегистрировать свое приложение. В ответ вы отправите разработчику ключ API, возможно, по электронной почте.
- Используйте API управления Edge, чтобы интегрировать функции регистрации приложений и доставки ключей на свой веб-сайт.
- Для платной учетной записи Edge используйте портал Apigee Developer Services, который имеет встроенную поддержку регистрации приложений и доставки ключей API.
Дополнительные сведения см. в разделе Регистрация приложений и управление ключами API .
Задача 4. Документируйте свои API
Важным моментом при публикации продуктов API является предоставление документации и механизма обратной связи с разработчиками. Порталы разработчиков с функциями социальных публикаций все чаще используются для общения с сообществом разработчиков. Это включает в себя передачу статического контента, такого как документация по API и условия использования, а также динамического контента, предоставляемого сообществом, такого как блоги и форумы, а также функций поддержки клиентов.
Вы можете создать собственный веб-сайт для развертывания документации или, если у вас есть платная учетная запись Edge, вы можете использовать портал Apigee Developer Services . Портал имеет встроенную поддержку документации, блогов, форумов и других типов контента, необходимых для поддержки вашего сообщества разработчиков.
SmartDocs позволяет документировать ваши API на портале Developer Services таким образом, чтобы документация по API была полностью интерактивной. Интерактивная документация с помощью SmartDocs означает, что пользователи портала могут:
- Прочитайте об API
- Отправьте живой запрос к API
- Просмотр оперативного ответа, полученного от API
Например, на следующем рисунке показан API, документированный на портале с помощью SmartDocs. Этот API предоставляет информацию о погоде для определенного места:
Разработчик вводит значение параметра запроса «w», чтобы указать местоположение, а затем нажимает кнопку «Отправить запрос», чтобы увидеть действующий запрос и ответ. Создавая интерактивную документацию по вашим API, вы облегчаете пользователю портала изучение, тестирование и оценку ваших API.
API управления Edge — это REST API, который позволяет вам получать доступ к службам API с помощью любого HTTP-клиента. Apigee использует SmartDocs для создания интерактивной документации для API управления Edge. См. документацию по API здесь .
Дополнительную информацию см. в разделе Использование SmartDocs для документирования API .