INTEGRITY Dokumentace

Vytváření vývojářských portálů

Jakmile váš koncové body jsou uložené, API Shield zároveň slouží jako katalog API. API Shield dokáže na základě znalostí o vašich API vytvořit interaktivní dokumentační portál, nebo můžete nahrát nový soubor se schématem OpenAPI a dokumentační portál vytvořit ad hoc.

Chcete-li vytvořit portál pro vývojáře:

  1. V dashboardu Cloudflare přejděte na Security Settings stránce.

    Přejděte na Nastavení ↗
  2. Filtrovat podle Zneužití API.

  3. Na Vytvoření portálu pro vývojáře, vyberte Vytvořit pobočku.

  4. Nahrajte soubor schématu OpenAPI v3.0 nebo vyberte existující schéma z API Shield.

  5. Vyberte Stáhnout soubory projektu , abyste uložili lokální kopii souborů, které se nahrají do Cloudflare Pages. Stažení souborů projektu se hodí, pokud chcete projekt jakkoli upravit a poté novou verzi ručně nahrát do Pages.

  6. Vyberte Vytvořit projekt Pages , čímž zahájíte vytváření projektu. Automaticky se vytvoří nový projekt Pages a vaše API schéma se spolu s dalším podpůrným statickým obsahem automaticky nahraje do projektu.

  7. Vyberte Nasadit web.

Vlastní domény

Chcete-li místo domény pages.dev použít vlastní doménu, přečtěte si Dokumentace k vlastním doménám Pages.

Dostupnost

Vytváření vývojářských portálů je dostupné všem předplatitelům API Shield. Tato funkce využívá k hostování výsledného portálu Cloudflare Pages. Další informace najdete v Pages ohledně omezení vašeho aktuálního tarifu.

Omezení

Tato funkce v současnosti používá open source Redoc ↗ projekt z Redocly ↗. Možnosti vlastního tématu a značky najdete na Repozitář Redoc na GitHubu ↗.

Chcete-li upravit výslednou stránku, stáhněte si soubory projektu ještě před vytvořením projektu Pages. Poté můžete vytvořit nový projekt Pages s upravenými soubory, které splňují vaše brandingové požadavky.