iT邦幫忙

2024 iThome 鐵人賽

DAY 16
0

API(應用程式介面,Application Programming Interface)是一組定義了應用程式或服務之間如何相互溝通的規則和協議。它提供了一種標準化的方式,使不同軟體系統之間可以交換數據或使用彼此的功能。

API 的作用通常包括:

  1. 抽象性:API 將底層的複雜邏輯和實現隱藏起來,提供簡單的介面給開發者。
  2. 可重用性:API 允許其他應用程式重複使用特定的功能,而不必重新實現該功能。
  3. 互操作性:API 允許不同的軟體系統進行互動,無論它們是使用不同的編程語言還是架構。

舉個例子🌰
當一個應用程式通過 API 向另一個服務請求資料時,API 會規定這個請求的格式(如 HTTP 請求的結構)、需要哪些參數,以及如何處理返回的數據。

在 Odoo 等企業資源規劃系統中,API 可能被用來與其他系統(例如 CRM、會計系統、電子商務平台)集成,實現自動化工作流等功能。

直接這樣講有點抽象 用實際收穫舉例一下吧~

我、銀行網路服務(API)、銀行系統

當你在網上進行轉帳或查詢賬戶餘額時,你會通過銀行的網路服務(API)操作,而不是直接與銀行的內部系統溝通。你輸入轉帳金額或查詢請求,網路服務(API)會將這些請求轉交給銀行的內部系統,該系統處理請求並返回結果。銀行的網路服務(API)就像中介,使得你可以輕鬆地進行銀行業務,而不需直接了解銀行系統的詳細運作。

WebAPIOpenAPI 是兩種與 API 相關的重要概念,但它們的用途和範疇有所不同:

WebAPI

WebAPI 是指通過網路(通常是 HTTP 協議)提供的 API。它使得不同的應用程式可以通過互聯網進行交互。WebAPI 的主要特點包括:

  • 協議:通常基於 HTTP 或 HTTPS 協議。
  • 格式:數據格式一般是 JSON 或 XML。
  • 用途:用於在不同的應用程序或系統之間傳輸數據或提供功能。

範例:許多現代應用程式(如社交媒體、地圖服務等)都提供 WebAPI,讓開發者可以通過 HTTP 請求獲取資料或操作服務。

OpenAPI

OpenAPI(以前稱為 Swagger)是一種用於描述和定義 WebAPI 的標準。它提供了一種標準化的方式來描述 API 的結構、功能和操作,從而使得 API 的使用、理解和測試變得更加容易。OpenAPI 的主要特點包括:

  • 描述格式:通常使用 JSON 或 YAML 格式來描述 API 的結構。
  • 功能:提供 API 的端點、參數、返回格式、認證方式等詳細資訊。
  • 工具支持:許多工具和庫(如 Swagger UI、Swagger Codegen)可以根據 OpenAPI 描述文件生成 API 文檔、客戶端代碼和伺服器代碼。

範例:如果使用 OpenAPI 描述一個 WebAPI,可以通過生成的文檔自動了解如何調用這個 API,並且可以使用自動生成的代碼快速構建應用程序。

WebAPI 是實際的接口,用於提供功能或數據,而 OpenAPI 是描述這些接口的標準,使得 API 更易於理解和使用。


上一篇
DAY15業務流程管理
下一篇
DAY17WebAPI?OpenAPI?有什麼差別嗎
系列文
「Odoo 解構:開源 ERP 平台的進階設計與實踐」30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言