Api
“API” 可以是 REST HTTP API、GraphQL、操作系统 API、库函数 API 等。通过约定输入输出,封装实现细节,使 frontend、第三方服务或微服务能安全协作。API design、versioning、documentation(OpenAPI)是工程重点。
- “Document every public API before the partner integration launches.” (合作伙伴集成上线前记录每个公开 API。)
- “Rate limiting protects the API from abusive traffic.” (限流保护 API 免受恶意流量。)
- “The mobile team consumes the same backend API as the web app.” (移动团队与 Web 应用共用同一后端 API。)
缩写词:Application(应用)+ Programming(编程)+ Interface(接口)。
首字母缩写,无词缀;口语中常读作 A-P-I 三个字母。
API economy 中许多公司以 API 为核心产品;breaking API change 是跨团队沟通敏感话题。
- 固定搭配: “REST API” (REST 接口), “public API” (公开 API), “API key” (API 密钥)
- 全称: Application Programming Interface
- 相关: endpoint, SDK
App 之间对话的 Interface——API 就是那份“对话合同”。
“A missing field in the API response caused silent failures until contract tests were added.” (API 响应缺字段导致静默失败,直到补上契约测试。)