Cloudflare

Iteration isn't just for code: here are our latest API docs

Nov 16, 2022Claire Waters, Kristian Freeman
Iteration isn't just for code: here are our latest API docs
SummaryAI, from the source post

This post details the technical implementation of Cloudflare's new API documentation site, which leverages the OpenAPI specification and Stoplight Elements. The site is built and deployed using Cloudflare Pages with Pages Functions to optimize and cache OpenAPI schema files. This approach allows for dynamic updates to documentation when schema files in GitHub are modified, ensuring consistency between API definitions and their documentation without requiring full site redeployments. The use of OpenAPI standardizes API content and enables the use of numerous code generation and documentation tools.

More from the API Definition and Developer Experience trail