匯入 gRPC API

發行項
05/21/2024

適用於：開發人員 | 進階

本文將說明如何將 gRPC 服務以 API 的形式匯入 APIM。接著，您可以在 APIM 中管理 API、安全存取並套用其他原則，並透過閘道將 gRPC API 要求傳遞至 gRPC 後端。

若要將 gRPC API 新增至 APIM，您需要：

將 API 的 Protobuf (通訊協定緩衝區) 定義檔上傳至 APIM
指定 gRPC 服務的位置
在 APIM 中設定 API

APIM 支援使用下列類型的 gRPC 服務方法進行傳遞：一元、伺服器串流、用戶端串流和雙向串流。如需 gRPC 的背景資訊，請參閱 gRPC 簡介。

注意

目前，只有自我裝載閘道才支援 gRPC API，APIM 執行個體的受控閘道並不支援 gRPC API。
目前，Azure 入口網站或 APIM 開發人員入口網站中的測試主控台不支援測試 gRPC API。
匯入僅限於單一 Protobuff (.proto) 檔案。

必要條件

API 管理執行個體。如果您還沒有執行個體，請完成下列快速入門：建立 Azure API 管理執行個體。
在執行個體中佈建的閘道資源。如果您還沒有閘道資源，請參閱在 Azure APIM 中佈建自我裝載閘道。
可在本機使用的 gRPC Protobuff (.proto) 檔案，以及可透過 HTTPS 存取的 gRPC 服務。

新增 gRPC API

入口網站

在 Azure 入口網站中，瀏覽至您的 API 管理執行個體。
在左側功能表中，選取 [API] > [+ 新增 API]。
在 [定義新的 API] 底下，選取 [gRPC]。
在 [建立 gRPC API] 視窗中，選取 [完整]。
針對 gRPC API，您必須指定下列設定：
1. 在 [上傳結構描述] 中，選取與所要匯入 API 相關聯的本機 .proto 檔案。
2. 在 [gRPC 伺服器 URL] 中，輸入 gRPC 服務的位址。此位址必須可透過 HTTPS 存取。
3. 在 [閘道] 中，選取您想要用來公開 API 的閘道資源。
  
  重要
  
  在公開預覽版中，您只能選取自我裝載閘道。不支援受控閘道。
輸入其餘設定以設定 API。這些設定會在匯入和發佈您的第一個 API 教學課程中說明。
選取建立。

API 會新增至 [API] 清單。您可以移至 API 的 [設定] 索引標籤來檢視或更新設定。

使用 .NET 呼叫 gRPC 服務

如需使用 .NET 呼叫 gRPC 服務的詳細資訊，請參閱下列文章：

附加其他 API

您可撰寫由不同服務所公開 API 的 API，包含：

OpenAPI 規格
SOAP API
GraphQL API
在 Azure App Service 中託管的 Web 應用程式
Azure 函數應用程式
Azure Logic 應用程式
Azure Service Fabric

使用下列步驟，將不同的 API 附加至您現有的 API。

注意

在您匯入另一個 API 後，作業就會附加至目前的 API。

移至 Azure 入口網站中的 Azure API 管理執行個體。
在 [概觀] 頁面上，或從左側功能表，選取 [API]。
在您要附加另一個 API 的 API 旁，按一下 ...。
從下拉式功能表中選取 [匯入]。
選取要從中匯入 API 的服務。