技术博客
技术博客
围绕工程效率、系统交付、健身实践与 AI 工程化进行沉淀。
Pagination
介绍 RESTful API 中 Offset 分页、Cursor 分页、稳定排序、过滤一致性和页面大小控制等设计规范。
Performance
介绍 RESTful API 中压缩、部分响应、ETag、分页、Prefer 和 HTTP 缓存等性能优化实践。
HTTP Status Codes and Errors
介绍 RESTful API 中 HTTP 状态码、客户端错误、服务端错误、批量响应和 Problem JSON 的设计规范。
HTTP Requests
介绍 RESTful API 中 GET、POST、PUT、PATCH、DELETE 等 HTTP 方法的语义、属性和请求设计实践。
Resources
围绕业务资源建模、资源命名、层级设计和标识符设计的 RESTful API 指南。
Resource Naming and URI Design
介绍资源命名、URI 路径、路径参数、查询参数和 HTTP Header 的 RESTful API 设计规范。
通用 API 设计指南
从 API First、OpenAPI Specification 到 API 用户文档，梳理 RESTful API 设计与交付中的通用实践。
Common Data Types
介绍 API 中常用字段、资源标识、时间字段、类型字段以及分页链接等通用数据类型约定。
Data Formats
介绍 JSON、二进制数据、Media Type、标准字段格式、日期时间、数字精度以及国家、语言和货币编码的 API 设计指南。
Deprecation
介绍 API Deprecation、Sunset、迁移窗口和生命周期沟通机制的设计指南。
Compatibility
关于 API 向后兼容、破坏性变更、版本策略和消费者健壮性的设计指南。
API Security
围绕 OAuth 2.0、TLS、Scopes、JWT 和权限命名规范，整理 RESTful API 的通用安全设计原则。
API Meta Information
介绍 API 元信息、语义化版本、API 标识符和 Audience 分类等通用设计规范。
API 设计原则
从 REST、RPC、Postel 原则和 API First 出发，梳理如何设计简单、一致、稳定且易于长期演进的 API。