Build developer portals
Once endpoints are saved into Endpoint Management, API Shield doubles as an API catalog. API Shield can build an interactive documentation portal with the knowledge it has of your APIs, or you can upload a new OpenAPI schema file to build a documentation portal ad-hoc.
- Log in to the Cloudflare dashboard ↗ and select your account and domain.
- Go to Security > API Shield > Settings.
- Under Create a developer portal, select Create site.
- Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
- Select Download project files to save a local copy of the files that will be uploaded to Cloudflare Pages. Downloading the project files can be helpful if you wish to modify the project in any way and then upload the new version manually to Pages.
- Select Create pages project to begin project creation. A new Pages project will be automatically created and your API schema will be automatically uploaded to the project along with other supporting static content.
- Select Deploy site.
To create a vanity domain instead of using the pages.dev domain, refer to the Pages custom domain documentation.
Building developer portals is available to all API Shield subscribers. This feature uses Cloudflare Pages to host the resulting portal. Refer to Pages for any limitations of your current subscription plan.
This feature currently uses the open source Redoc ↗ project from Redocly ↗. For custom theme and branding options, visit the Redoc GitHub repository ↗.
To modify the resulting page, download the project files before creating the Pages project. You can create a new Pages project with the modified files you have made to meet your branding guidelines.