使用Azure Function輕易打造屬於自己的Web API

2019-03-02

2579
0
Azure
2019-03-04

你是否曾為了寫幾支API而建置一台伺服器？

我們都知道建置的過程是非常冗長的，

而微軟提供的無伺服器服務(Serverless) — Azure Function剛好可以無痛解決你的需求，

本篇將使用Azure Function一步一步帶你打造屬於自己的Web API。

筆者實作環境如下：

Windows 10
VSCode(安裝傳送門)
npm v5.6.0
Node.js v8.11.4 (安裝傳送門)
Azure帳號(免費申請傳送門)

如果還沒有Azure帳號的朋友，

可參考這名網友的文章教學申請即可。

安裝相關套件

在這裡我們會安裝兩個套件：

VSCode Extension - Azure Functions：快速建立及佈署Azure Functions專案。
Azure Functions Core Tools ：使用本機端開發及測試。

首先我們先來幫VSCode安裝Azure Functions的擴充套件(筆者電腦環境已安裝)

安裝完後請建立一個azure-function-node-api-sample的空白資料夾，

使用快捷鍵(Ctrl + ~)開啟Console頁面，

接著輸入cd azure-funtion-node-api-sample切換資料夾目錄，

並使用npm安裝azure function tool。

npm install -g azure-functions-core-tools@2

安裝完後輸入func指令如果有看到閃電的圖案表示安裝成功。

動手實作

接著筆者會介紹如何建立範本專案，

並在專案內加入Azure Function函數。

建立Azure Function範本專案

Azure Function範本專案相對於Function而言，

就像一個專案裡可以有很多功能的概念。

我們可以點選左側Azure的圖示，

接著依下圖順序產生範本專案(省略登入Azure帳號過程)。

語言部份筆者使用的是javascript，

你也可以選擇其他語言格式。

完成後建立會建立下列檔案。

這邊簡單補充一下：

host.json：包含了該Function App的全域組態設定。
proxies.json：設定proxy規則可使外部呼叫API URL與內部函數URL做路由規則對應。
.funcignore：記載發佈到Azure上時要忽略的函數資訊。

cli建立方式

在剛建立的資料夾目錄下輸入func init，

接著在runtime及language分別選擇node及javascript，

眼尖的讀者應該不難發現，

雖然cli建立範本專案感覺起來比較方便，

但cli的方式缺少了某些檔案(.git目錄、.funcignore、proxies.json)，

筆者建議還是使用GUI的方式建立會比較完整。

加入Azure Function

做到這裡我們已經完成Azure Function專案的建立，

接下來我們一樣使用點選的方式來加入Function。

點擊右上方中間的圖示後選擇目錄，

它會列出Azure Function上支援的函數類型，

這邊選擇第一個HTTP trigger。

接著輸入函數名稱HelloFunction

授權等級為了方便測試我們選擇匿名。

完成後會在HelloFunction的目錄下加入範例程式碼，

index.js就是我們Request的進入點了！

index.js

module.exports = async function (context, req) {
    context.log('JavaScript HTTP trigger function processed a request.');

    if (req.query.name || (req.body && req.body.name)) {
        context.res = {
            // status: 200, /* Defaults to 200 */
            body: "Hello " + (req.query.name || req.body.name)
        };
    }
    else {
        context.res = {
            status: 400,
            body: "Please pass a name on the query string or in the request body"
        };
    }
};