Skip to content

非公式 / UnofficialCloudflare, Inc. 非提携。アカウント情報は入力しないでください。Not affiliated with Cloudflare, Inc. Do not enter Cloudflare credentials here.Official docsこのサイトについてプライバシー

開発者ポータルを構築する

最終更新 Markdown で表示Agent セットアップ

エンドポイントを保存すると、API Shield は API カタログとしても機能します。API Shield は、把握している API の情報から対話型のドキュメントポータルを構築できます。または、新しい OpenAPI スキーマファイルをアップロードして、その場でドキュメントポータルを作成することもできます。

開発者ポータルを作成する手順は次のとおりです。

  1. Cloudflare ダッシュボードで、Security Settings ページを開きます。

    公式ダッシュボードで Settings を開く ↗
  2. API abuse で絞り込みます。

  3. Create a developer portal で Create site を選択します。

  4. OpenAPI v3.0 スキーマファイルをアップロードするか、API Shield にある既存スキーマを選びます。

  5. Download project files を選択し、Cloudflare Pages にアップロードされるファイルのローカルコピーを保存します。プロジェクトを変更してから、新しいバージョンを Pages に手動アップロードしたい場合に便利です。

  6. Create pages project を選択し、プロジェクト作成を開始します。新しい Pages プロジェクトが自動で作成され、API スキーマとその他の静的コンテンツがプロジェクトにアップロードされます。

  7. Deploy site を選択します。

カスタムドメイン

pages.dev ドメインの代わりにバニティドメインを使う場合は、Pages のカスタムドメインのドキュメント を参照してください。

利用可否

開発者ポータルの構築は、API Shield の全サブスクライバーが利用できます。完成したポータルのホストには Cloudflare Pages を使います。現在のサブスクリプションプランの制限については、Pages を参照してください。

制限

この機能は現在、Redocly ↗ のオープンソースプロジェクト Redoc ↗ を使っています。カスタムテーマやブランディングのオプションは、Redoc の GitHub リポジトリ ↗ を参照してください。

結果のページを変更する場合は、Pages プロジェクトを作成する前にプロジェクトファイルをダウンロードします。ブランドガイドラインに合わせて変更したファイルで、新しい Pages プロジェクトを作成できます。

役に立ちましたか?