Лучшие практики для создания вашего портала

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

Apigee рекомендует применять передовые методы, описанные в следующих разделах, при создании портала.

Привлекайте свою аудиторию

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

Позвольте пользователям опробовать ваши API

Автоматически создавайте интерактивную документацию по API на основе спецификаций OpenAPI, чтобы пользователи могли:

  • Узнайте об API
  • Отправьте живой запрос к API

  • Просмотр оперативного ответа, полученного от API

    Дополнительную информацию см. в разделе Публикация API .

Рассмотрите основные пути обучения

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

Внедрить поисковую оптимизацию (SEO)

Убедитесь, что ваш контент доступен для поиска. Инвестируйте в SEO, которое улучшит ваш рейтинг в результатах поиска и позволит пользователям находить ваш контент.

Поисковая оптимизация

Используйте следующие рекомендации при структурировании вашего контента. Дополнительную информацию и дополнительные рекомендации Google можно найти в Руководстве по поисковой оптимизации Google .

Лучшая практика Описание Преимущества
Создавайте удобные URL-адреса Создавайте простые для понимания и удобочитаемые URL-адреса. Определите удобный URL-адрес страницы при добавлении страниц на портал, как описано в разделе Создание страницы .
  • Передаёт цель страницы в удобочитаемой форме.
  • Полное или частичное совпадение ключевых слов в URL-адресе страницы повышает рейтинг в поиске.
  • Обычно URL-адреса появляются в результатах поиска.
Укажите описательное имя портала Определите уникальное и описательное имя для своего портала, как описано в разделе «Управление порталами» . Этот контент используется для заполнения тега <title> домашней страницы ( index ) вашего портала.
  • Полное или частичное совпадение ключевых слов в заголовке повышает рейтинг в поиске.
  • Обычно содержимое заголовков страниц отображается в первой строке результатов поиска.
Сделайте ваш сайт удобным для навигации Определите структуру навигации, которая имеет логический смысл, как описано в разделе Настройка навигации .
  • Держит пользователей в курсе.
  • Помогает пользователям быстро и легко найти нужный им контент.
Используйте хорошее сочетание ключевых фраз в контенте. Включайте ключевые слова в свой контент, когда это актуально и имеет смысл. Известность строки ключевого слова на вашей странице может повысить рейтинг страницы в результатах поиска. Попробуйте предсказать, какие ключевые слова пользователи могут использовать при поиске вашего контента. Будьте осторожны, не используйте ключевые слова , то есть злоупотребляйте ключевыми словами исключительно с целью повышения рейтинга в поиске. Это может привести к тому, что ваш сайт будет наказан поисковыми системами. Пользователи, ищущие контент, с большей вероятностью получат релевантные результаты.

Создайте сообщество разработчиков

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