Changelog

本變更記錄會列出 API 設計指南的重要變更。

2025-06

  • 將「設計」頁面的命名慣例重新導向至 Google AIP。

2024-10

  • 將「設計」頁面重新導向至 Google AIP，但「目錄結構」和「命名慣例」除外。

2021-12

  • 將「Networked API」改為「Network API」，與 https://google.aip.dev/9 保持一致。

2021-09

  • 記錄 Google API 錯誤格式 v1 和 v2。

2021-04

  • 推出以可見度為準的版本控管功能。

  • 在詞彙中新增 API 標題。

2021-03

  • 新增僅限輸出欄位的註解。

  • 更新列舉值指南，一律加入明確的 _UNSPECIFIED 值。

  • 新增如何產生及剖析資源名稱的相關指南。

  • 在標準欄位中新增 progress_percent。

2021-02

  • 新增有關 proto3 optional 原始欄位的指南。

2021-01

  • 更新「錯誤」頁面，說明與 google.rpc.ErrorInfo 和 google.api.ErrorReason 相關的最新改善項目。

  • 新增使用 oauth2l、curl 和系統參數排解 Google API 錯誤的指南。

  • 在「錯誤」頁面中新增 502 錯誤代碼說明。這是網路錯誤，而非 API 錯誤。

2020-12

  • 為確保全域一致性，套件名稱應使用單數元件名稱。 套件名稱不得使用底線。

2020-09

  • 修正部分欄位說明規定；將 RFC 2119 以外的「必須」用法，改為 RFC 2119「應」指令。

  • 移除 bool deleted 標準欄位，改用 google.protobuf.Timestamp delete_time (已列出)。

2020-07

  • 更新 documentation.md，使其符合 https://google.aip.dev/192#formatting。請勿在 proto 註解中使用 Markdown 資料表和原始 HTML。

  • 新增 ErrorInfo，用於處理錯誤。

  • 新增設計模式的大型酬載。

2020-04

  • 在詞彙表中，將 Cloud API 重新命名為 Google Cloud API。
  • 將 API 和服務視為 API 服務的同義詞。

2020-02

  • 更新版本控管，新增兩種版本控管策略 (以管道為準和以發布為準)，移除有關點版本的指引，並變更我們對語意版本控管的稱呼。

2020-01

  • 在設計模式中新增資料保留期限。

2019-11

  • 在詞彙中新增「Cloud API」術語。
  • 建議用戶端僅針對 UNAVAILABLE 錯誤重試。

2019-06

  • 在設計模式中新增「Bool vs Enum vs String」。

2019-03

  • 在標準欄位中新增系統參數。

2019-02

  • 在設計模式中新增網域範圍名稱。

2018-03

  • 在設計模式中新增串流半關閉語意。

2018-02

  • 在標準欄位中新增 read_time。

2018-01

  • 新增 API 服務定義的結構定義參考資料。

2017-12

  • 說明 API 主要版本必須為 proto 套件名稱的最後一個組成部分。

2017-11

  • 說明 Create 方法會擷取輸入資源的原因。
  • 說明沒有複數形式的集合 ID，例如 evidence (證據) 和 weather (天氣)。
  • 在設計模式中新增單例資源。
  • 說明縮寫字和版本的 C# 命名慣例。

2017-09

  • 在標準欄位中新增 mime_type。
  • 在標準欄位中新增 expire_time。
  • 在標準欄位中新增 start_time 和 end_time。

2017-02

  • 在詞彙中新增「API 端點」。
  • 在標準欄位中新增 update_mask。
  • 在標準方法中新增 FieldMask 的連結。
  • 提及 OpenAPI 規格不支援無正負號整數。
  • 說明方法名稱的動詞應使用祈使語氣。
上一頁
目錄結構