Рекомендации по созданию портала

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

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

Взаимодействуйте с аудиторией

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

Как разрешить пользователям тестировать ваши API

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

  • Подробнее об API…
  • Отправка запроса к API

  • Как посмотреть мгновенный ответ, полученный от API

    Подробнее о том, как опубликовать API…

Основные учебные планы

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

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

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

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

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

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

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

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