Руководство по Получение доступа к порталу разработчика и его настройка

ОБЛАСТЬ ПРИМЕНЕНИЯ: Разработчик | Базовый | Базовая версия 2 | Стандартный | Standard v2 | Премия

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

В этом руководстве описано следующее:

• получение доступа к управляемой версии портала разработчика;
• переход к административному интерфейсу;
• настройка содержимого;
• Публикция изменений
• просмотр опубликованного портала.

Дополнительные сведения о функциях и параметрах портала разработчика см. в обзоре портала разработчика azure Управление API.

Необходимые компоненты

• Выполните задачи в кратком руководстве по созданию экземпляра службы управления API Azure.
• Импорт и публикация API.

Получение доступа к порталу от имени администратора

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

1. Перейдите к экземпляру Управления API на портале Azure.

2. Если вы создали экземпляр на уровне служб версии 2, поддерживающем портал разработчика, сначала включите портал разработчика.

   1. В меню слева на портале разработчика выберите параметры портала.
   2. В окне параметров портала выберите "Включено". Выберите Сохранить.

   Для включения портала разработчика может потребоваться несколько минут.

3. В меню слева в разделе Портал разработчика щелкните Обзор портала. Затем нажмите кнопку "Портал разработчика" в верхней панели навигации. Откроется новая вкладка браузера с административной версией портала.

Общие сведения об административном интерфейсе портала

Администратор может настроить содержимое портала с помощью визуального редактора.

• Используйте параметры меню слева для создания или изменения страниц, мультимедиа, макетов, меню, стилей или параметров веб-сайта.

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

• Кроме того, сохраните или отмените внесенные изменения или опубликуйте веб-сайт.

Совет

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

Добавление изображения в библиотеку мультимедиа

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

1. В меню слева в визуальном редакторе выберите Media.
2. Выполните одно из следующих действий:
   • Выберите "Отправить файл " и выберите локальный файл образа на компьютере.
   • Выберите файл ссылки. Введите URL-адрес ссылки на файл изображения и другие сведения. Выберите Скачать.
3. Нажмите кнопку "Закрыть ", чтобы выйти из библиотеки мультимедиа.

Совет

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

Замена логотипа по умолчанию на домашней странице

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

1. На портале разработчика выберите логотип Contoso по умолчанию в левой верхней части панели навигации.
2. Выберите Изменить.
3. Во всплывающем оккупа "Рисунок" в разделе "Основной" выберите "Источник".
4. Во всплывающем итоге выберите один из следующих вариантов:
   • Изображение, уже отправленное в библиотеку мультимедиа
   • Отправка файла для отправки нового файла изображения в библиотеку мультимедиа
   • Нет , если вы не хотите использовать логотип
5. Логотип обновляется в режиме реального времени.
6. Щелкните за пределами всплывающих окон, чтобы выйти из библиотеки мультимедиа.
7. В верхней строке нажмите кнопку "Сохранить".

Изменение содержимого на домашней странице

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

Измените структуру и содержимое созданных страниц несколькими способами. Например:

• Выберите существующие элементы текста и заголовка для редактирования и форматирования содержимого.

• Добавьте раздел на страницу, наведите указатель мыши на пустую область и щелкните синий значок со знаком плюса. Выберите один из нескольких макетов разделов.

  

• Добавьте мини-приложение (например, текст, изображение, настраиваемый список мини-приложений или API), наведите указатель мыши на пустую область, а затем щелкните серый значок со знаком плюса.

  

• Переупорядочение элементов на странице путем перетаскивания.

Изменение основного цвета сайта

Чтобы изменить цвета, градиенты, типографию, кнопки и другие элементы пользовательского интерфейса на портале разработчика, измените стили сайта. Например, измените основной цвет, используемый в панели навигации, кнопках и других элементах, чтобы соответствовать фирменной символике вашей организации.

1. На портале разработчика в левом меню визуального редактора выберите "Стили".
2. В разделе Цвета выберите элемент стиля цвета, который нужно изменить. Например, выберите primary.
3. Выберите "Изменить цвет".
4. Выберите цвет из средства выбора цветов или введите шестнадцатеричный код цвета.
5. В верхней строке выберите "Сохранить".

Обновленный цвет применяется к сайту в режиме реального времени.

Совет

Если вы хотите, добавьте и присвойте другому элементу цвета, нажав кнопку +Добавить цвет на странице стилей.

Изменение фонового изображения на домашней странице

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

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

2. Справа от статьи "Изменить" во всплывающем меню выберите стрелку вверх вниз (переключиться на родительский).

3. Выберите раздел "Изменить".

4. Во всплывающем меню раздела в разделе "Фон" выберите один из значков:

   

   • Очистка фона для удаления фонового изображения
   • Фоновое изображение, выбор изображения из библиотеки мультимедиа или отправка нового образа
   • Цвет фона, чтобы выбрать цвет из средства выбора цветов или очистить цвет
   • Фоновый градиент, выбор градиента на странице стилей сайта или очистка градиента

5. В разделе "Размер фона" выберите нужный фон.

6. В верхней строке нажмите кнопку "Сохранить".

Изменение макета по умолчанию

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

По умолчанию портал разработчика поставляется с двумя макетами:

• Главная — используется для домашней страницы (шаблон /URL)

• По умолчанию — используется для всех остальных страниц (шаблон /*URL- адреса).

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

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

1. В меню слева визуального редактора выберите Pages.
2. Выберите вкладку "Макеты" и выберите "По умолчанию".
3. Выберите рисунок логотипа в левом верхнем углу и нажмите кнопку "Изменить".
4. В разделе "Основной" выберите "Источник".
5. Во всплывающем окне мультимедиа выберите одно из следующих элементов:
   • Изображение, уже отправленное в библиотеку мультимедиа
   • Отправка файла для отправки нового файла изображения в файл мультимедиа, который можно выбрать
   • Нет , если вы не хотите использовать логотип
6. Логотип обновляется в режиме реального времени.
7. Щелкните за пределами всплывающих окон, чтобы выйти из библиотеки мультимедиа.
8. В верхней строке нажмите кнопку "Сохранить".

Изменение меню навигации

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

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

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

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

1. В меню слева визуального редактора выберите меню "Сайт".
2. Слева разверните меню анонимного пользователя.
3. Выберите параметры (значок шестеренки) рядом с кнопкой "Регистрация" и нажмите кнопку "Удалить".
4. Выберите Сохранить.

Изменение параметров сайта

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

1. В меню слева в визуальном редакторе выберите пункт "Параметры".
2. Во всплывающем параметров введите метаданные сайта, которые нужно изменить. При необходимости настройте favicon для сайта из образа в библиотеке мультимедиа.
3. В верхней строке нажмите кнопку "Сохранить".

Совет

Если вы хотите изменить доменное имя сайта, необходимо сначала настроить личный домен в Управление API экземпляре. Дополнительные сведения о пользовательских доменных именах см. в Управление API.

Публикация портала

Чтобы сделать портал и последние изменения на нем доступными для посетителей, его нужно опубликовать.

Чтобы опубликовать из административного интерфейса портала разработчика, выполните следующие действия.

1. Убедитесь, что вы сохранили изменения, нажав кнопку "Сохранить ".

2. В меню в верхней части окна выберите " Опубликовать сайт". Это может занять несколько минут.

   

Совет

Другим вариантом является публикация сайта из портал Azure. На странице обзора портала экземпляра Управление API в портал Azure выберите "Опубликовать".

Посещение опубликованного портала

Чтобы просмотреть изменения после публикации портала, обратитесь к нему по тому же URL-адресу, что и панель администрирования, например https://contoso-api.developer.azure-api.net. Просмотрите портал в отдельном сеансе браузера (используя режим инкогнито или частный режим просмотра) в качестве внешнего посетителя.

Применение политики CORS для API

Чтобы позволить посетителям портала тестировать API через встроенную интерактивную консоль, включите CORS (общий доступ к ресурсам между источниками) в API, если вы еще этого не сделали. На странице обзора портала экземпляра Управление API в портал Azure выберите включить CORS. Подробнее.

Следующие шаги

Из этого руководства вы узнали, как:

• получение доступа к управляемой версии портала разработчика;
• переход к административному интерфейсу;
• настройка содержимого;
• Публикция изменений
• просмотр опубликованного портала.

Перейдите к следующему руководству:

Импорт API и управление ими с помощью Visual Studio Code

См. связанное содержимое портала разработчика:

• Обзор портала разработчика в службе управления API Azure
• Настройте проверку подлинности на портале разработчика с именами пользователей и паролями, идентификатором Microsoft Entra или Azure AD B2C.
• Дополнительные сведения о настройке и расширении функциональных возможностей портала разработчика.