专注于开发灵活API的设计文档。
AIP是总结了谷歌API设计决策的设计文档,它也为其他人提供了用文档记录API设计规则和实践的框架和系统。
| 基础 | |
|---|---|
| 1 | AIP目的和指南 |
| 2 | AIP编号规则 |
| 3 | AIP版本管理 |
| 200 | 先例 |
| 8 | AIP风格与指导 |
| 9 | 术语表 |
| 流程 | |
| 100 | API设计评审常见问题 |
| 205 | Beta版本发布前置条件 |
| API概念 | |
| 111 | 平面 |
| 资源设计 | |
| 121 | 面向资源设计 |
| 122 | 资源名字 |
| 123 | 资源类型 |
| 124 | 资源关联 |
| 126 | 枚举 |
| 128 | 声明友好接口 |
| 129 | 服务器修改的值与默认值 |
| 156 | 单例资源 |
| 236 | 策略预览 |
| 操作 | |
| 130 | 方法 |
| 131 | 标准方法:Get |
| 132 | 标准方法:List |
| 133 | 标准方法:Create |
| 134 | 标准方法:Update |
| 135 | 标准方法:Delete |
| 136 | 自定义方法 |
| 151 | 耗时操作 |
| 231 | 批量方法:Get |
| 233 | 批量方法:Create |
| 234 | 批量方法:Update |
| 235 | 批量方法:Delete |
| 域 | |
| 140 | 域名字 |
| 202 | 域 |
| 203 | 域行为文档 |
| 141 | 数量 |
| 142 | 时间与时间段 |
| 143 | 标准代号 |
| 144 | 重复域 |
| 145 | 范围 |
| 146 | 泛化域 |
| 147 | 敏感域 |
| 148 | 标准域 |
| 149 | 未设定域的值 |
| 216 | 状态 |
| 设计模式 | |
| 152 | 作业 |
| 153 | 导入和导出 |
| 154 | 资源时效性验证 |
| 155 | 请求标识 |
| 157 | 部分应答 |
| 158 | 分页 |
| 159 | 跨集合读 |
| 160 | 过滤 |
| 161 | 字段掩码 |
| 162 | 资源修订 |
| 163 | 变更验证 |
| 164 | 软删除 |
| 165 | 基于条件的删除 |
| 210 | Unicode |
| 211 | 授权检查 |
| 214 | 资源过期 |
| 217 | 不可达资源 |
| 兼容性与版本管理 | |
| 180 | 向后兼容 |
| 181 | 稳定级别 |
| 182 | 外部软件依赖 |
| 185 | API版本管理 |
| 优化 | |
| 191 | 文件和目录结构 |
| 192 | 文档 |
| 193 | 错误 |
| 194 | 自动重发配置 |
| 协议缓冲区 | |
| 127 | HTTP与gRPC转码 |
| 213 | 通用组件 |
| 215 | API特定proto |