Blog
Technical Blog
Notes on engineering efficiency, delivery quality, fitness practice, and AI engineering experiments.
Pagination
Guidelines for offset and cursor pagination, stable ordering, filtering consistency, page sizes, and navigation links.
Performance
Guidelines for compression, partial responses, ETags, pagination, Prefer, and HTTP caching in RESTful APIs.
HTTP Status Codes and Errors
Guidelines for HTTP status codes, client and server errors, batch responses, Problem JSON, and safe error handling.
HTTP Requests
Guidelines for HTTP method semantics, safe and idempotent operations, query parameters, complex operations, and asynchronous request tracking.
Resources
Guidelines for business resource modeling, naming, hierarchy, and identifier design in RESTful APIs.
Resource Naming and URI Design
Guidelines for resource naming, URI paths, path parameters, query parameters, and HTTP headers.
General API Design Guidelines
A practical guide to API First, OpenAPI specifications, API reviews, validation, and user documentation for RESTful APIs.
Common Data Types
Guidelines for common API fields, resource identifiers, timestamps, types, and pagination link relations.
Data Formats
Guidelines for JSON, binary data, media types, standard property formats, date and time, numeric precision, and international codes.
Deprecation
Guidelines for API deprecation, sunset dates, migration windows, and lifecycle communication.
Compatibility
Guidelines for backward compatibility, breaking changes, versioning, and consumer robustness in RESTful APIs.
API Security
A practical guide to OAuth 2.0, TLS, scopes, JWT token sizing, and permission naming for RESTful APIs.
API Meta Information
A practical guide to API metadata, semantic versioning, API identifiers, and audience classification.