google api設計指南 簡介

2021-09-12 13:02:06 字數 625 閱讀 2634

這是聯網 api 的通用設計指南。它自 2014 年起在 google 內部使用,是 google 在設計 cloud api 和其他 google api 時遵循的指南。此設計指南在此處共享,以便為外部開發者提供資訊,並使我們所有人更容易協同工作。

在設計 grpc api 時,google cloud endpoints 開發者可能會發現本指南特別有用,我們強烈建議此類開發者使用這些設計原則。但我們不強制要求使用本指南。您可以使用 cloud endpoints 和 grpc,而無需遵循本指南。

本指南適用於 rest api 和 rpc api,尤其適用於 grpc api。grpc api 使用 protocol buffers 定義其 api 介面和 api 服務配置,以配置其 api 服務,包括 http 對映、日誌記錄和監控。google api 和 cloud endpoints grpc api 使用 http 對映功能進行 json/http 到 protocol buffers/rpc 的轉碼。

本文件中使用的要求級別關鍵字(「必須」、「不得」、「必需」,「應」、「不應」、「應該」、「不應該」、「建議」、「可以」和「可選」)將按 rfc 2119 中的描述進行解釋。

在本文件中,這些關鍵字使用粗體突出顯示。

Google API設計指南 自定義方法

翻譯自 api design guide custom methods 此篇文章討論如何在 api 設計中使用自定義方法。自定義方法指五個標準方法之外的 api 方法。應該 should 只有當標準方法不能完成需要的功能時才使用自定義方法。一般情況下,api 設計者應該 should 在可行的情況下...

Redis 指南(1) 簡介

1 儲存結構 有過指令碼語言程式設計經驗的讀者對字典 或稱對映,關聯陣列 資料結構一定很熟悉,如 dict key value 中 dict 是乙個字典結構變數,字串 key 是鍵名,而 value 是鍵值,在字典中我們可以獲取或設定鍵名對應的鍵值,也可以刪除乙個鍵。redis 是 remote d...

Instruments使用指南 簡介

instruments是乙個動態跟蹤和分析的mac os x和ios 的應用程式。它是乙個靈活和強大的工具,讓您跟蹤乙個或多個程序,並檢查所收集的資料。這樣,instruments幫助您了解使用者程式和作業系統的行為。有了instruments應用程式,您可以使用特殊的工具 如instruments...