專注于開發靈活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 |