エンドポイントを保存すると、API Shield は API カタログとしても機能します。API Shield は、把握している API の情報から対話型のドキュメントポータルを構築できます。または、新しい OpenAPI スキーマファイルをアップロードして、その場でドキュメントポータルを作成することもできます。
開発者ポータルを作成する手順は次のとおりです。
-
Cloudflare ダッシュボードで、Security Settings ページを開きます。
Settings を開く ↗ -
API abuse で絞り込みます。
-
Create a developer portal で Create site を選択します。
-
OpenAPI v3.0 スキーマファイルをアップロードするか、API Shield にある既存スキーマを選びます。
-
Download project files を選択し、Cloudflare Pages にアップロードされるファイルのローカルコピーを保存します。プロジェクトを変更してから、新しいバージョンを Pages に手動アップロードしたい場合に便利です。
-
Create pages project を選択し、プロジェクト作成を開始します。新しい Pages プロジェクトが自動で作成され、API スキーマとその他の静的コンテンツがプロジェクトにアップロードされます。
-
Deploy site を選択します。
pages.dev ドメインの代わりにバニティドメインを使う場合は、Pages のカスタムドメインのドキュメント を参照してください。
開発者ポータルの構築は、API Shield の全サブスクライバーが利用できます。完成したポータルのホストには Cloudflare Pages を使います。現在のサブスクリプションプランの制限については、Pages を参照してください。
この機能は現在、Redocly ↗ のオープンソースプロジェクト Redoc ↗ を使っています。カスタムテーマやブランディングのオプションは、Redoc の GitHub リポジトリ ↗ を参照してください。
結果のページを変更する場合は、Pages プロジェクトを作成する前にプロジェクトファイルをダウンロードします。ブランドガイドラインに合わせて変更したファイルで、新しい Pages プロジェクトを作成できます。