← Cloudflare API Shield / api-shield / management-and-monitoring
Создание порталов для разработчиков
Когда ваши конечные точки сохранены, API Shield одновременно выступает как каталог API. API Shield может создать интерактивный портал документации на основе имеющихся данных о ваших API, либо вы можете загрузить новый файл схемы OpenAPI, чтобы создать портал документации по запросу.
Чтобы создать портал для разработчиков:
-
На панели управления Cloudflare перейдите к разделу Security Settings страницу.
Перейдите в Настройки ↗ -
Фильтр по Злоупотребление API.
-
На Создание портала для разработчиков, выберите Создать сайт.
-
Загрузите файл схемы OpenAPI v3.0 или выберите уже существующую схему из API Shield.
-
Выберите Скачать файлы проекта чтобы сохранить локальную копию файлов, которые будут загружены в Cloudflare Pages. Загрузка файлов проекта может пригодиться, если вы хотите внести изменения в проект, а затем вручную загрузить новую версию в Pages.
-
Выберите Создать проект Pages чтобы начать создание проекта. Будет автоматически создан новый проект Pages, а ваша схема API вместе с другим вспомогательным статическим содержимым будет автоматически загружена в этот проект.
-
Выберите Развернуть сайт.
Пользовательские домены
Чтобы использовать собственный домен вместо домена pages.dev, ознакомьтесь с Документация Pages по пользовательским доменам.
Доступность
Создание порталов для разработчиков доступно всем подписчикам API Shield. Эта функция использует Cloudflare Pages для размещения готового портала. См. Pages об ограничениях вашего текущего тарифного плана.
Ограничения
На данный момент эта функция основана на решении с открытым исходным кодом Redoc ↗ проект из Redocly ↗. Для настройки темы и брендинга перейдите в Репозиторий Redoc на GitHub ↗.
Чтобы изменить готовую страницу, скачайте файлы проекта перед созданием проекта Pages. Затем можно создать новый проект Pages, используя изменённые файлы, адаптированные под ваши брендовые требования.