開発者ポータルの構築
一度エンドポイントがエンドポイント管理に保存されると、API ShieldはAPIカタログとしても機能します。API Shieldは、あなたのAPIに関する知識をもとにインタラクティブなドキュメントポータルを構築することができ、または新しいOpenAPIスキーマファイルをアップロードして、その場でドキュメントポータルを構築することもできます。
- Cloudflareダッシュボード ↗にログインし、アカウントとドメインを選択します。
- セキュリティ > API Shield > 設定に移動します。
- 開発者ポータルの作成の下で、サイトを作成を選択します。
- OpenAPI v3.0スキーマファイルをアップロードするか、API Shieldから既存のスキーマを選択します。
- プロジェクトファイルをダウンロードを選択して、Cloudflare Pagesにアップロードされるファイルのローカルコピーを保存します。プロジェクトファイルをダウンロードすることで、プロジェクトを何らかの方法で修正し、新しいバージョンを手動でPagesにアップロードする際に役立ちます。
- ページプロジェクトを作成を選択して、プロジェクトの作成を開始します。新しいPagesプロジェクトが自動的に作成され、あなたのAPIスキーマが他のサポートする静的コンテンツとともに自動的にプロジェクトにアップロードされます。
- サイトをデプロイを選択します。
pages.devドメインを使用する代わりにバニティドメインを作成するには、Pagesカスタムドメインのドキュメントを参照してください。
開発者ポータルの構築は、すべてのAPI Shieldサブスクライバーが利用可能です。この機能は、結果として得られるポータルをホストするためにCloudflare Pagesを使用します。現在のサブスクリプションプランの制限については、Pagesを参照してください。
この機能は現在、Redoc ↗プロジェクトのオープンソース版を使用しています。Redocly ↗のカスタムテーマやブランディングオプションについては、Redoc GitHubリポジトリ ↗を訪れてください。
結果のページを修正するには、Pagesプロジェクトを作成する前にプロジェクトファイルをダウンロードしてください。ブランディングガイドラインに合わせて修正したファイルで新しいPagesプロジェクトを作成することができます。