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

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

Компания 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-сообществе.