Skip to content
ADP
API Design PrincipleBETA

[ADP-4] 詞彙表

本詞彙表記錄了 ADP 之間共用的術語和常見的 API 相關概念。它按字母順序組織,以便於參考,並預期隨時間增長。

絕對 URI (Absolute URI)

包含所有必要組件以獨立定位資源的 URI,如 scheme、主機和路徑。絕對 URI 可用於直接訪問網絡上的資源。

API(應用程式介面)(Application Programming Interface)

用於構建和整合應用程式軟體的一組定義和協議。API 通過提供標準化的方式來訪問軟體組件的功能,允許不同的軟體組件進行通信和共享數據。

API 端點 (API Endpoint)

客戶端可以訪問 API 的特定 URL。每個端點對應 API 中的特定功能或資源。例如:https://api.example.com/v1/users

API 金鑰 (API Key)

用於驗證使用者、開發者或呼叫程式對 API 的唯一標識符。它通常用於不需要更高安全級別的專案。

API 景觀 (API Landscape)

API 的整體生態系統,包括其類型、使用模式以及不同 API 之間的關係。它提供了 API 如何在各種應用程式和服務中互動和整合的全面視圖。

API 模擬 (API Mocking)

使用假數據模擬真實 API 行為的做法。當實際 API 不可用或為避免達到速率限制時,這對測試和開發很有用。

API 消費者(客戶端)(API Consumer (Client))

使用 API 訪問另一個應用程式或系統提供的資源或服務的應用程式或系統。

API 提供者(伺服器)(API Provider (Server))

向其他應用程式或系統提供 API 的應用程式或系統,提供對其資源或服務的訪問。

身份驗證 (Authentication)

驗證嘗試訪問 API 的使用者、設備或系統身份的過程。

授權 (Authorization)

確定經過身份驗證的使用者、設備或系統是否有權訪問 API 中特定資源或執行某些操作的過程。

集合 (Collection)

可通過 API 作為整體訪問和管理的同類型資源組。例如,使用者檔案集合或文章集合。

CORS(跨源資源共享)(Cross-Origin Resource Sharing)

允許一個域的網頁向不同域發出請求的安全機制。這對於被網頁應用程式訪問的 API 很重要。

CURIE(縮寫的統一資源標識符參考)

一種簡化的 URI 表示法,允許使用簡短的前綴來引用完整的 URI。CURIE 使得在文件中引用資源變得更加簡潔和易於閱讀。

事件消費者 (Event Consumer)

接收和處理事件生產者生成的事件的系統或組件。

事件生產者 (Event Producer)

生成事件以供事件消費者使用的系統或組件。這些事件通常代表系統內的變化或更新。

可擴展枚舉 (Extensible Enum)

可以在初始集合之外擴展額外值的枚舉類型。這允許在軟體設計中有更大的靈活性和適應性。

GraphQL

一種用於 API 的查詢語言和運行時,允許客戶端精確請求所需的數據,使得在單個請求中獲取多個資源成為可能。

HAL(超文本應用語言)(Hypertext Application Language)

一種簡單的格式,為 RESTful API 中的資源提供一致且簡單的超連結方式。HAL 使用標準連結關係和嵌入資源。

HATEOAS(作為應用狀態引擎的超媒體)(Hypermedia as the Engine of Application State)

REST 應用程式架構的一個約束,允許客戶端使用伺服器提供的超媒體連結動態導航 API。

IANA(互聯網號碼分配機構)(Internet Assigned Numbers Authority)

負責協調全球互聯網系統的組織,包括管理 IP 地址、域名和協議參數。

IEEE(電機電子工程師學會)(Institute of Electrical and Electronics Engineers)

致力於推進廣泛技術領域(包括計算和電子)技術和標準的專業協會。

JSON(JavaScript 物件表示法)(JavaScript Object Notation)

一種輕量級的數據交換格式,易於人類閱讀和編寫,也易於機器解析和生成。JSON 在 API 中廣泛用於數據交換。

JSON 指針 (JSON Pointer)

用於識別 JSON 文件中特定值的語法。它使用字符串語法定義值的路徑,使得引用和操作 JSON 結構的特定部分變得容易。

JWT(JSON Web 令牌)(JSON Web Token)

一種緊湊的、URL 安全的方式,用於表示要在兩方之間傳輸的聲明。JWT 通常用於網絡應用程式中的身份驗證和授權。

微服務 (Microservices)

將應用程式結構化為鬆散耦合服務集合的架構風格。

OAuth

一種用於安全授權的開放標準,常用於網絡和移動應用程式。

OpenAPI

用於構建 API 的規範,提供了一種標準方式來描述、生產、消費和可視化 RESTful 網絡服務。以前稱為 Swagger。

OIDC(開放ID連接)(OpenID Connect)

一種基於 OAuth 2.0 的身份驗證協議,允許客戶端驗證使用者的身份並獲取基本的個人資料信息。OIDC 提供了一種簡單的方式來實現單點登錄(SSO)功能。

分頁 (Pagination)

用於將大量結果分割成更小的塊(頁面)以提高 API 回應的性能和可用性的技術。

Postman

一種流行的 API 開發和測試工具,允許開發者設計、調試、測試和文件化 API。

速率限制 (Rate Limiting)

用於控制進出網絡的流量數量的策略,通常應用於 API 以防止濫用並確保公平使用。

相對 URI (Relative URI)

相對於另一個 URI(稱為基本 URI)的 URI。它不包括 scheme、主機或端口,通常用於引用同一上下文中的資源。

資源 (Resource)

可以使用 API 訪問和操作的網絡上的任何可識別實體。資源由 URI 表示,可以是文件、圖像、服務或任何其他實體。

RESTful

指遵循 REST(表述性狀態轉移)原則的 API,這是一種用於設計網絡應用程式的架構風格。RESTful API 使用 HTTP 方法(GET、POST、PUT、DELETE 等)並且是無狀態的,提供可預測、可擴展和可緩存的交互。

RFC(請求評論)(Request for Comments)

來自 IETF(互聯網工程任務組)和其他組織的一種出版物類型,描述適用於互聯網和互聯網連接系統工作的方法、行為、研究或創新。

RFC 要求關鍵詞

在RFC中使用的特定詞語,用於指示規範的要求級別。這些關鍵詞包括:

  • MUST(或 REQUIRED):表示絕對要求。
  • MUST NOT:表示絕對禁止。
  • SHOULD(或 RECOMMENDED):表示可能存在忽略此項的合理理由,但在選擇不同做法之前應充分理解其全部影響。
  • SHOULD NOT(或 NOT RECOMMENDED):表示在特定情況下該行為可能是可接受的,但在實施任何以此標籤描述的行為之前,應充分理解其全部影響。
  • MAY(或 OPTIONAL):表示真正的可選功能。

這些關鍵詞在RFC 2119中定義,並用於在其他RFC中精確指定要求。

Swagger UI

一個開源工具,為使用 OpenAPI 規範文件化的 RESTful API 生成用戶友好的介面,用於探索和測試。

URI(統一資源標識符)(Uniform Resource Identifier)

明確識別特定資源的字符串。URI 在網絡上廣泛使用,包括 URL 和 URN。

URL(統一資源定位符)(Uniform Resource Locator)

一種特定類型的 URI,不僅識別資源,還通過描述其主要訪問機制(如 HTTP、FTP)和資源的網絡位置提供定位資源的方法。

UUID(通用唯一標識符)(Universally Unique Identifier)

用於在計算機系統中唯一識別資訊的 128 位數字。UUID 在許多上下文中使用,包括數據庫和分佈式系統。

版本控制 (Versioning)

隨時間管理 API 變更的做法,通常通過在 API 的端點或標頭中包含版本號來實現。

Webhook

一種從 API 接收實時通知的方法,當某些事件發生時,而不是不斷輪詢更新。

XML(可擴展標記語言)(Extensible Markup Language)

一種定義了一組規則用於編碼文件的標記語言,格式既可供人類閱讀又可供機器讀取。它有時在 API 中作為 JSON 的替代品使用。

YAML(YAML 不是標記語言)(YAML Ain't Markup Language)

一種人類友好的數據序列化標準,可以作為 JSON 或 XML 的替代品用於 API 配置和數據交換。