API Definition and Developer Experience
The Cloudflare API now uses OpenAPI schemas

The Cloudflare API now uses OpenAPI schemas

11/16/2022 · Garrett Galow

What this post added

This post details Cloudflare's transition from JSON Hyper-Schema to OpenAPI for defining its APIs. It explains the benefits of OpenAPI, including improved tooling support for API documentation generation (using Stoplight Elements), local API mocking for testing (using Stoplight Prism), and automatic library generation for various programming languages (using openapi-generator). The post also describes the technical approach to migrating existing APIs, which involved building an auto-conversion tool from JSON Hyper-Schema to OpenAPI, allowing for a seamless transition without halting ongoing API development.

Read the original post ↗