在Beego中使用Swagger並結合Postman進行API測試

Beego是一個快速開發Go語言網路應用程式的Web框架，它提供了許多功能和工具來簡化開發流程。這些特性和工具包括支援Swagger（一種API文件產生工具）和Postman（一種API測試工具），兩者都可以讓開發人員方便地管理和測試API，本文將介紹如何在Beego中使用Swagger並結合Postman進行API測試。

一、安裝Swagger

Swagger是一種開源框架，用於設計、建置、文件化和測試RESTful Web服務。透過Swagger，你可以在動態產生的API文件中查看每個API方法的請求和回應。

首先，你需要安裝Swagger。輸入以下指令：

go get -u github.com/swaggo/swag/cmd/swag

安裝完畢後，再輸入以下指令：

swag init

這將在你的Beego應用程式的根目錄下產生一個docs資料夾，其中包含產生的Swagger文件。

二、整合Swagger到Beego

接下來，你需要整合Swagger到Beego。要做到這一點，你需要在你的main.go檔案中引入swagger和beego / context依賴項。

import(

"github.com/astaxie/beego"
"github.com/astaxie/beego/context"
_ "your-app-doc-path/docs"

)

現在，在你的main.go檔案的init（）函數中加入以下程式碼：

func main( ) {

if beego.BConfig.RunMode == beego.DEV {
    beego.BConfig.WebConfig.DirectoryIndex = true
    beego.BConfig.WebConfig.StaticDir["/swagger"] = "swagger"
    // 添加路由，可以自定义，这里设置为/swagger
    beego.InsertFilter("/*", beego.BeforeRouter, func(ctx *context.Context) {
        ctx.Output.Header("Access-Control-Allow-Origin", "*")
        ctx.Output.Header("Access-Control-Allow-Headers", "Content-Type,Token")
        ctx.Output.Header("Access-Control-Allow-Methods", "POST,GET")
    })
}

// 注册Swagger路由
beego.BConfig.WebConfig.StaticDir["/docs"] = "docs"
beego.BeeApp.Handlers.Get("/docs/*", func(ctx *context.Context) {
    ctx.Output.Header("Content-Type", "text/html;charset=utf-8")
    ctx.Output.Body(swaggerFiles.Index)
})

}

這個程式碼將在你的應用程式根目錄下建立一個swagger資料夾，用來存放Swagger UI檔案。在Beego初始化時，Swagger UI目錄將被註冊為一個靜態路由。因為Swagger UI是一組靜態HTML、CSS和JavaScript文件，所以它們是從靜態資源目錄存取的。

你需要輸入以下URL在瀏覽器中開啟Swagger UI：

http://localhost:[port]/docs/index.html

這裡，請自行替換[port]為你的伺服器連接埠號碼。

三、寫Swagger註解

在整合Swagger之後，現在你需要為你的API寫Swagger註解。可以透過以下方式來執行：

首先，建立一個檔案swagger.go，然後加入以下程式碼：

package controllers

/* 運算類別
*/

// swagger:parameters add sub
type Operands struct {

// The first operand
// in: path
// required: true
A int `json:"a"`
// The second operand
// in: path
// required: true
B int `json:"b"`

}

*/

type OperandsResultWrapper struct {

// in:body
Body struct {
    // 运算结果
    Result int `json:"result,omitempty"`
}

相加/

//
// 用於相加
//
// 支援的謂詞: GET
// 參數:
// A: (path) - first operand(只能為整數)
// B: (path) - second operand (只能為整數)
// 接受內容:
// Produces:
// 傳回結果(application/json)
// 錯誤(application/json)
//
// swagger:parameters add
// swagger:response OperResult
func (o *OperationController) Add() {

// ...

運算類別（參數類型）描述了傳遞給API的參數。
• 傳回結果（回應類型）描述了API傳回給客戶端的值的形式。

以上是在Beego中使用Swagger並結合Postman進行API測試的詳細內容。更多資訊請關注PHP中文網其他相關文章！