Category Archives
API Documentation
Comprehensive guides for REST, GraphQL, gRPC APIs, OpenAPI 3.1 specifications, and Developer Experience (DX).
Showing 5 published articles
API Documentation
8 min read
How to craft copy-pasteable, verified SDK code samples that reduce Time-to-First-Hello-World (TTFHW). Covers multi-language tabs, mock credentials, and automated code test harnesses.
API Documentation
9 min read
How to design, document, and standardize REST API error responses using RFC 9457 and RFC 7807 Problem Details. Includes concrete JSON payloads, error catalogues, and...
API Documentation
9 min read
How to document high-performance gRPC services and Protocol Buffers (proto3): documenting streaming RPCs, generating automated reference docs with protoc-gen-doc, and managing schema evolution.
API Documentation
8 min read
A comprehensive guide to documenting GraphQL APIs: writing expressive Schema Definition Language (SDL) comments, managing deprecation lifecycles, and documenting query depth limits.
API Documentation
8 min read
A production masterclass on OpenAPI Specification 3.1: JSON Schema Draft 2020-12 alignment, polymorphic schemas, webhooks, authentication contracts, and interactive documentation tooling.