實戰應用：使用Beego進行API測試

近年來，由於網路技術的發展，API（Application Programming Interface）開發和測試已經成為了網路公司的重要組成部分。由於API測試的流程簡單，效率高，程式碼重用率高，因此越來越多的網路公司開始採用自動化測試來測試其API介面。本文將詳細介紹如何使用Beego框架進行API測試。

一、Beego框架簡介

Beego是一個基於Go語言的Web框架，由於其高效、簡單、易學的特點，被越來越多的開發者所使用。除此之外，Beego還提供了豐富的工具和插件，包括ORM、Websocket、Redis、CORS和Swagger等工具，可以大幅提高開發的效率。

二、開發工具

在開始開發之前，首先要準備好必要的開發工具。本文所使用的開發環境如下：

1.作業系統: Windows 10

2.Go版本：go1.11.4 windows/amd64

3.Beego版本：1.12. 1

4.測試框架：GoConvey

5.瀏覽器：Chrome

6.程式碼編輯器： Sublime Text 3

7.資料庫： MySQL

三、安裝與設定

1.安裝Go

首先，需要安裝Go語言的開發環境。在官方網站中下載對應的安裝包（https://golang.org/dl/）。下載完成後，雙擊運行安裝包即可完成安裝。

2.安裝Beego

在安裝Go語言之後，接下來需要安裝Beego框架。可以透過以下指令來安裝Beego:

go get -u github.com/astaxie/beego

此指令會將Beego框架下載到GOPATH路徑下。

3.安裝GoConvey

GoConvey是一個用於Go語言的單元測試框架，可以偵測專案中所有的測試案例，並自動執行這些測試案例。安裝GoConvey的方法如下:

go get github.com/smartystreets/goconvey

4.安裝MySQL

在本文中，我們使用MySQL資料庫。請前往MySQL官方網站下載並安裝：https://dev.mysql.com/downloads/mysql/

#在安裝MySQL時，建議安裝自帶的MySQL Workbench。

四、建立Beego專案

建立Beego專案有多種方式，可以使用命令列，也可以使用Beego提供的工具web。在本文中，我們使用命令列建立一個名為"MyAPI"的專案。在命令列中輸入以下命令：

bee new MyAPI

然後會在目前目錄下建立一個名為"MyAPI"的Beego專案。

接下來，我們需要用到之前安裝的MySQL資料庫。在MySQL Workbench中，新建一個資料庫並將其命名為MyAPI，執行以下SQL語句：

CREATE TABLE users
(
id INT PRIMARY KEY AUTO_INCREMENT,
username VARCHAR(20),
password VARCHAR(50),
created_at TIMESTAMP DEFAULT NOW()
)

這個SQL語句建立了一個名為users的表，包含id、username、password和created_at四個字段。

接下來，我們需要賦予資料庫存取權限。開啟MySQL Workbench，選擇Database -> Users and Privileges -> Add Account，建立一個新用戶，並為該用戶分配對MyAPI資料庫的讀取、寫入權限。

五、寫API

在建立好Beego專案之後，我們需要在專案中加入一些API接口，以便測試。在MyAPI專案的main.go中，我們加入如下程式碼：

package main

import (
    "MyAPI/controllers"
    "github.com/astaxie/beego"
    "github.com/astaxie/beego/orm"
    _ "github.com/go-sql-driver/mysql"
)

func init() {
    orm.RegisterDriver("mysql", orm.DRMySQL)
    orm.RegisterDataBase("default", "mysql", "username:password@tcp(127.0.0.1:3306)/MyAPI?charset=utf8")
    orm.RegisterModel(new(models.User))
    orm.RunSyncdb("default", false, true)
}

func main() {
    beego.Router("/api/user/:id", &controllers.UserController{})
    beego.Run()
}

上述程式碼中，我們使用beego.Router()方法將"/api/user/:id"這個API路徑與controllers.UserController {}這個控制器綁定。我們也使用ORM（物件關聯映射）技術與MySQL資料庫進行交互，使用RegisterDataBase()方法註冊預設資料庫，在資料庫中建立users表，並將User結構體註冊為ORM模型。

編寫controllers.UserController{}控制器時，我們新增了以下程式碼來處理HTTP GET請求並取得某個特定的使用者：

func (c *UserController) Get() {
    o := orm.NewOrm()
    user := models.User{}
    id, _ := strconv.Atoi(c.Ctx.Input.Param(":id"))
    user.ID = id
    err := o.Read(&user)
    if err != nil {
        c.Data["json"] = err.Error()
    } else {
        c.Data["json"] = user
    }
    c.ServeJSON()
}

六、測試API介面

#在本文中，我們使用GoConvey來測試API介面。我們需要在Beego專案中新增一個名為tests的目錄，並在該目錄中建立一個名為user_test.go的測試檔案。

package tests

import (
    "MyAPI/models"
    "github.com/astaxie/beego/orm"
    "net/http"
    "net/http/httptest"
    "testing"
    "github.com/smartystreets/goconvey/convey"
)

func TestGetUser(t *testing.T) {
    convey.Convey("GetUser", t, func() {
        o := orm.NewOrm()
        user := models.User{Username: "testuser", Password: "testpass"}
        id, _ := o.Insert(&user)
        req, _ := http.NewRequest("GET", "/api/user/"+strconv.Itoa(int(id)), nil)
        resp := httptest.NewRecorder()
        beego.BeeApp.Handlers.ServeHTTP(resp, req)
        convey.So(resp.Code, convey.ShouldEqual, 200)
    })
}

對於上述程式碼，我們使用了GoConvey提供的convey套件來測試API介面。我們先使用ORM新建了一個名為testuser的用戶，透過HTTP GET請求取得這個用戶，然後使用convey.So()方法判斷取得使用者資訊的HTTP狀態是否為200。

七、啟動測試

透過命令列進入MyAPI專案的目錄，執行下列指令：

go test ./tests/...

這條指令會對MyAPI專案中的所有測試案例進行測試，並展示測試結果。

八、總結

本文介紹了使用Beego進行API測試的基本流程。透過Beego框架和GoConvey工具，可以更好的進行API測試，為我們的專案提供更好的保障。同時，我們也需要不斷學習新的技術和工具，保持對開發和測試的熱情，提升我們的技術水準。

以上是實戰應用：使用Beego進行API測試的詳細內容。更多資訊請關注PHP中文網其他相關文章！