TechPrufer
Get started
Cloudflare
Cloudflare logoCloudflare · Feature trail

API Bindings

1 post · Sep 2017 – Apr 2024

What this trail covers

Cloudflare's API bindings have evolved to support automated generation from OpenAPI schemas, ensuring consistent quality, parity, and faster delivery of updates across multiple languages. This includes enforcing API design conventions and style guides through linting rules integrated into CI pipelines. The use of Stainless as a generation engine allows for SDK-specific customizations while maintaining a clear division of responsibilities between service teams, the API team, and the generation platform.

All Cloudflare trails
  1. Lessons from building an automated SDK pipelineThis post details the transition from manually maintained SDKs to an automated pipeline for generating Cloudflare's SDKs (TypeScript, Go, Python) using OpenAPI schemas and the Stainless generation engine. Key technical contributions include: establishing guiding principles for SDK generation (language-agnostic output, uniform support, fast feedback loops), implementing Redocly CLI plugins for API design linting (e.g., enforcing API token authentication order and description formatting), and integrating with Stainless to map OpenAPI schemas to SDK methods. This automation significantly reduces the manual effort and potential for error in SDK maintenance and updates.
  2. A New API Binding: cloudflare-phpThis post introduces the new `cloudflare-php` SDK, available via Packagist. It details the design decisions made, including the exclusive use of PHP 7 features (scalar type hinting, return type declarations) for improved code quality and maintainability. The post explains the use of object composition and dependency injection for flexibility in handling authentication, HTTP adapters, and API endpoints. It also highlights the adoption of the PSR-7 standard for HTTP responses, enabling effective mocking of HTTP requests for unit testing.