匯出 (0) 列印
全部展開

自訂 API

更新日期: 2014年7月

Microsoft Azure 行動服務 可讓您在行動服務中定義一個或多個自訂 API。自訂 API 是行動服務中可由一個或多個標準 HTTP 方法存取的端點:GET、POST、PUT、PATCH、DELETE。在 JavaScript 後端行動服務中,自訂 API 指令碼會在入口網站中進行建立和編輯,或使用服務的 Git 儲存機制進行上傳。

在 .NET 後端行動服務中,自訂 API 會定義為 Visual Studio 專案中的類別,而該類別衍生自 ApiController 並實作可傳回 ApiServices 物件的 Services 屬性。管理入口網站 不支援 .NET 後端自訂 API。

在 JavaScript 後端中,您可以為自訂 API 所支援的每個 HTTP 方法定義個別函數匯出,全都匯出到單一指令碼檔案中。當收到使用給定方法的自訂 API 要求時,將會叫用註冊的指令碼。自訂 API 可讓您公開未對應到插入、更新、刪除或讀取作業的伺服器功能,或是當做已排程的工作來公開。自訂 API 的呼叫方式是透過以下一般格式傳送受支援方法的 HTTP 要求到 URI。

https://<service_name>.azure-mobile.net/api/<api_name>

若要註冊 JavaScript 自訂 API 指令碼,請按一下 [建立] 按鈕、選取用來呼叫 API 之 HTTP 方法的權限,然後按一下 [確定]。指令碼編輯器中會產生及顯示以下 POST 方法的 “Hello World” 預設實作。

exports.post = function(request, response) {
    // Use "request.service" to access features of your mobile service, e.g.:
    //   var tables = request.service.tables;
    //   var push = request.service.push;

    response.send(200, "Hello World");
};

如需如何建立及呼叫自訂 API 的範例,請參閱<從用戶端呼叫自訂 API>(Windows 市集 C# / Windows 市集 JavaScript / Windows Phone / iOS / Android)。

在 JavaScript 後端中,自訂 API 基本上是一種 Node.js 模組,它會公開以標準方式對應至 HTTP 方法的一個或多個公用函數。這些函數會使用exports 物件 (例如之前的範例中處理 POST 要求的 exports.post) 來公開。系統會傳遞要求物件回應物件給每一個匯出的自訂 API 函數。這些物件是由 express.js 程式庫實作,而且會公開 express.js 程式庫的 API。

在自訂 API 中,您可以針對要求從服務物件存取伺服器指令碼的全域物件 (pushtablesmssql)。至於資料表作業,您可以針對自訂 API 支援的每個 HTTP 方法設定相同的權限。如果是經過驗證的用戶端,您也可以根據提供之要求物件user.userId 值執行使用者特有的授權。

note附註
當伺服器指令碼尚未在自訂 API 上註冊到 HTTP 方法時,該方法的要求會傳回 405 錯誤碼。

如需有關自訂 API 的詳細資訊,請參閱行動服務伺服器指令碼參考

顯示:
© 2014 Microsoft